users

List users

SecurityapiAuth

Request

query Parameters

account	string
account__label	string
account__name	string
archived	boolean
balance	string
created	string <date-time>
created__gt	string <date-time>
created__lt	string <date-time>
currency	string
currency__code	string
deactivated	boolean
email	string
email__contains	string
first_name	string
first_name__contains	string
group	string
group__isnull	boolean
id	string
id__contains	string
id__in	string
id_number	string
id_number__contains	string
language	string
last_login	string or null <date-time>
last_login__gt	string or null <date-time>
last_login__lt	string or null <date-time>
last_name	string
last_name__contains	string
mobile	string
mobile__contains	string
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: "AD" "AE" "AF" "AG" "AI" "AL" "AM" "AO" "AQ" "AR" "AS" "AT" "AU" "AW" "AX" "AZ" "BA" "BB" "BD" "BE" "BF" "BG" "BH" "BI" "BJ" "BL" "BM" "BN" "BO" "BQ" "BR" "BS" "BT" "BV" "BW" "BY" "BZ" "CA" "CC" "CD" "CF" "CG" "CH" "CI" "CK" "CL" "CM" "CN" "CO" "CR" "CU" "CV" "CW" "CX" "CY" "CZ" "DE" "DJ" "DK" "DM" "DO" "DZ" "EC" "EE" "EG" "EH" "ER" "ES" "ET" "FI" "FJ" "FK" "FM" "FO" "FR" "GA" "GB" "GD" "GE" "GF" "GG" "GH" "GI" "GL" "GM" "GN" "GP" "GQ" "GR" "GS" "GT" "GU" "GW" "GY" "HK" "HM" "HN" "HR" "HT" "HU" "ID" "IE" "IL" "IM" "IN" "IO" "IQ" "IR" "IS" "IT" "JE" "JM" "JO" "JP" "KE" "KG" "KH" "KI" "KM" "KN" "KP" "KR" "KW" "KY" "KZ" "LA" "LB" "LC" "LI" "LK" "LR" "LS" "LT" "LU" "LV" "LY" "MA" "MC" "MD" "ME" "MF" "MG" "MH" "MK" "ML" "MM" "MN" "MO" "MP" "MQ" "MR" "MS" "MT" "MU" "MV" "MW" "MX" "MY" "MZ" "NA" "NC" "NE" "NF" "NG" "NI" "NL" "NO" "NP" "NR" "NU" "NZ" "OM" "PA" "PE" "PF" "PG" "PH" "PK" "PL" "PM" "PN" "PR" "PS" "PT" "PW" "PY" "QA" "RE" "RO" "RS" "RU" "RW" "SA" "SB" "SC" "SD" "SE" "SG" "SH" "SI" "SJ" "SK" "SL" "SM" "SN" "SO" "SR" "SS" "ST" "SV" "SX" "SY" "SZ" "TC" "TD" "TF" "TG" "TH" "TJ" "TK" "TL" "TM" "TN" "TO" "TR" "TT" "TV" "TW" "TZ" "UA" "UG" "UM" "US" "UY" "UZ" "VA" "VC" "VE" "VG" "VI" "VN" "VU" "WF" "WS" "YE" "YT" "ZA" "ZM" "ZW"
orderby	Array of strings Ordering `last_login` - Last login `-last_login` - Last login (descending) `updated` - Updated `-updated` - Updated (descending) `created` - Created `-created` - Created (descending) Items Enum: "-created" "-last_login" "-updated" "created" "last_login" "updated"
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
retention_state	string
search	string
service	string
status	string
status__in	Array of strings Multiple values may be separated by commas.
temporary	boolean
updated	string <date-time>
updated__gt	string <date-time>
updated__lt	string <date-time>
user	string
username	string
username__contains	string

Responses

200

get/3/admin/users/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.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": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_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",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"deactivated": false,
"retention_state": "retaining",
"archived": false,
"last_login": 0
}
]
}
}

Create user

SecurityapiAuth

Request

Request Body schema:
application/json

id	string <= 64 characters
username	string <= 150 characters
email	string <email>
mobile	string
first_name	string or null <= 50 characters
last_name	string or null <= 50 characters
profile	string or null <uri>
groups	Array of strings or null [ 0 .. 1 ] items
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
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
metadata	any or null
timezone	string or null <= 100 characters
website	string or null <= 100 characters
business_name	string or null <= 100 characters
deactivated	boolean Default: false
retention_state	string `retaining` - Retaining `delete_requested` - Delete Requested `deleted` - Deleted Enum: "retaining" "delete_requested" "deleted"
archived	boolean Default: false

Responses

201

post/3/admin/users/

Request samples

Payload
Javascript SDK
Python SDK

{"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": ["string"
],
"id_number": "string",
"birth_date": "2019-08-24",
"language": "string",
"nationality": "AF",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"deactivated": false,
"retention_state": "retaining",
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_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",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"deactivated": false,
"retention_state": "retaining",
"archived": false,
"last_login": 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"
}
}
]
}
}
}

Retrieve user

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Responses

200

get/3/admin/users/{identifier}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.get({"id": userId})
.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",
"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",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"deactivated": false,
"retention_state": "retaining",
"archived": false,
"last_login": 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

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Request Body schema:
application/json
required

username required	string or null <= 150 characters ^[\w.@+-]+$
email	string <email>
mobile	string
first_name	string or null <= 50 characters
last_name	string or null <= 50 characters
profile	string or null <uri>
groups	Array of strings or null [ 0 .. 1 ] items
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
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
metadata	any or null
timezone	string or null <= 100 characters
website	string or null <= 100 characters
business_name	string or null <= 100 characters
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
deactivated	boolean Default: false
retention_state	string `retaining` - Retaining `delete_requested` - Delete Requested `deleted` - Deleted Enum: "retaining" "delete_requested" "deleted"
archived	boolean Default: false

Responses

200

put/3/admin/users/{identifier}/

Request samples

Payload
Javascript SDK
Python SDK

{"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": ["string"
],
"id_number": "string",
"birth_date": "2019-08-24",
"language": "string",
"nationality": "AF",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"status": "obsolete",
"deactivated": false,
"retention_state": "retaining",
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_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",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"deactivated": false,
"retention_state": "retaining",
"archived": false,
"last_login": 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"
}
}
]
}
}
}

Patially update user

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Request Body schema:
application/json

username	string or null <= 150 characters ^[\w.@+-]+$
email	string <email>
mobile	string
first_name	string or null <= 50 characters
last_name	string or null <= 50 characters
profile	string or null <uri>
groups	Array of strings or null [ 0 .. 1 ] items
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
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
metadata	any or null
timezone	string or null <= 100 characters
website	string or null <= 100 characters
business_name	string or null <= 100 characters
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
deactivated	boolean Default: false
retention_state	string `retaining` - Retaining `delete_requested` - Delete Requested `deleted` - Deleted Enum: "retaining" "delete_requested" "deleted"
archived	boolean Default: false

Responses

200

patch/3/admin/users/{identifier}/

Request samples

Payload
Javascript SDK
Python SDK

{"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": ["string"
],
"id_number": "string",
"birth_date": "2019-08-24",
"language": "string",
"nationality": "AF",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"status": "obsolete",
"deactivated": false,
"retention_state": "retaining",
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_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",
"gender": "male",
"title": "mr",
"marital_status": "single",
"fathers_name": "string",
"mothers_name": "string",
"grandfathers_name": "string",
"grandmothers_name": "string",
"central_bank_number": "string",
"metadata": null,
"timezone": "string",
"website": "string",
"business_name": "string",
"verified": true,
"verification": {"email": true,
"mobile": true
},
"status": "obsolete",
"created": 0,
"updated": 0,
"deactivated": false,
"retention_state": "retaining",
"archived": false,
"last_login": 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 user groups

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

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/admin/users/{identifier}/groups/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.groups.get(
  userId
).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": [{"name": "string",
"label": "string",
"description": "string",
"icon": "http://example.com",
"default": true,
"public": true,
"permissions": 0,
"tier": {"id": 0,
"level": -2147483648,
"name": "string",
"description": "string",
"requirements": [{"id": 0,
"requirement": "first_name",
"label": "string"
}
],
"limits": [{"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
],
"fees": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
],
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": null,
"currency": null,
"account_definition": null
}
]
},
"archived": true,
"created": 0,
"updated": 0
},
"tiers": [{"id": 0,
"level": 0,
"name": "string",
"description": "string"
}
],
"settings": {"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": {"id": null,
"name": null,
"label": null,
"tx_type": null
},
"currency": {"code": null,
"display_code": null,
"description": null,
"symbol": null,
"unit": null,
"divisibility": null,
"icon": null
},
"account_definition": {"name": null,
"label": null
}
}
],
"password_reset_url": "http://example.com",
"password_set_url": "http://example.com",
"email_verification_url": "http://example.com",
"deactivate_verification_url": "http://example.com",
"request_delete_verification_url": "http://example.com"
},
"archived": false,
"created": 0,
"updated": 0
}
]
}
}

Create account definitions

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Request Body schema:
application/json
required

group

required

string

Responses

201

post/3/admin/users/{identifier}/groups/

Request samples

Payload
Javascript SDK
Python SDK

{"group": "string"
}

Response samples

application/json

{"status": "success",
"data": {"name": "string",
"label": "string",
"description": "string",
"icon": "http://example.com",
"default": true,
"public": true,
"permissions": 0,
"tier": {"id": 0,
"level": -2147483648,
"name": "string",
"description": "string",
"requirements": [{"id": 0,
"requirement": "first_name",
"label": "string"
}
],
"limits": [{"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
],
"fees": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
],
"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"
},
"account_definition": {"name": "string",
"label": "string"
}
}
]
},
"archived": true,
"created": 0,
"updated": 0
},
"tiers": [{"id": 0,
"level": 0,
"name": "string",
"description": "string"
}
],
"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"
},
"account_definition": {"name": "string",
"label": "string"
}
}
],
"password_reset_url": "http://example.com",
"password_set_url": "http://example.com",
"email_verification_url": "http://example.com",
"deactivate_verification_url": "http://example.com",
"request_delete_verification_url": "http://example.com"
},
"archived": false,
"created": 0,
"updated": 0
}
}

Retrieve user group

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
identifier required	string^[a-zA-Z0-9\_\-]+$

Responses

200

get/3/admin/users/{identifier}/groups/{group_name}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.groups.get(
  userId, {"name": groupName}
).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"name": "string",
"label": "string",
"description": "string",
"icon": "http://example.com",
"default": true,
"public": true,
"permissions": 0,
"tier": {"id": 0,
"level": -2147483648,
"name": "string",
"description": "string",
"requirements": [{"id": 0,
"requirement": "first_name",
"label": "string"
}
],
"limits": [{"id": 0,
"value": 0,
"type": "max",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string"
}
],
"fees": [{"id": 0,
"name": "string",
"tx_type": "credit",
"subtype": "string",
"account_definition": "string",
"currency": "string",
"value": 0,
"percentage": 0,
"description": "string"
}
],
"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"
},
"account_definition": {"name": "string",
"label": "string"
}
}
]
},
"archived": true,
"created": 0,
"updated": 0
},
"tiers": [{"id": 0,
"level": 0,
"name": "string",
"description": "string"
}
],
"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"
},
"account_definition": {"name": "string",
"label": "string"
}
}
],
"password_reset_url": "http://example.com",
"password_set_url": "http://example.com",
"email_verification_url": "http://example.com",
"deactivate_verification_url": "http://example.com",
"request_delete_verification_url": "http://example.com"
},
"archived": false,
"created": 0,
"updated": 0
}
}

Delete user group

SecurityapiAuth

Request

path Parameters

group_name required	string^\w+$
identifier required	string^[a-zA-Z0-9\_\-]+$

Responses

200

delete/3/admin/users/{identifier}/groups/{group_name}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.groups.delete(userId, groupName)
.then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "sucess"
}

List user legal-terms

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

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/admin/users/{identifier}/legal-terms/

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
}
],
"archived": false,
"created": 0,
"updated": 0
}
]
}
}

Retrieve user legal-term

SecurityapiAuth

Request

path Parameters

identifier required	string^[a-zA-Z0-9\_\-]+$
term_id required	string^\d+$

Responses

200

get/3/admin/users/{identifier}/legal-terms/{term_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
}
],
"archived": false,
"created": 0,
"updated": 0
}
}

List user legal-term versions

SecurityapiAuth

Request

path Parameters

identifier required	string^[a-zA-Z0-9\_\-]+$
term_id 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/admin/users/{identifier}/legal-terms/{term_id}/versions/

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",
"archived": true,
"created": 0,
"updated": 0
}
]
}
}

Retrieve legal-term version

SecurityapiAuth

Request

path Parameters

identifier required	string^[a-zA-Z0-9\_\-]+$
term_id required	string^\d+$
version_id required	string^\d+$

Responses

200

get/3/admin/users/{identifier}/legal-terms/{term_id}/versions/{version_id}/

Response samples

application/json

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

List user messages

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

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/admin/users/{identifier}/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,
"section": "system",
"level": "info",
"message": "string",
"archived": false,
"author": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"created": 0,
"updated": 0
}
]
}
}

Create user message

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Request Body schema:
application/json
required

section	string `admin` - Admin `user` - User Enum: "admin" "user"
level	string `info` - Info `warning` - Warning `error` - Error Enum: "info" "warning" "error"
message required	string
archived	boolean Default: false

Responses

201

post/3/admin/users/{identifier}/messages/

Request samples

Payload

{"section": "admin",
"level": "info",
"message": "string",
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"section": "system",
"level": "info",
"message": "string",
"archived": false,
"author": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"created": 0,
"updated": 0
}
}

Retrieve user message

SecurityapiAuth

Request

path Parameters

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

Responses

200

get/3/admin/users/{identifier}/messages/{id}/

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"section": "system",
"level": "info",
"message": "string",
"archived": false,
"author": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"created": 0,
"updated": 0
}
}

List user permissions

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

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/admin/users/{identifier}/permissions/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.permissions.get(userId)
.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,
"section": "system",
"type": "accesscontrolrule",
"level": "view",
"properties": null
}
]
}
}

Create user permission

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Request Body schema:
application/json
required

required

Array of objects (AdminCreateUserPermission)

Responses

201

post/3/admin/users/{identifier}/permissions/

Request samples

Payload
Javascript SDK
Python SDK

{"permissions": [{"section": "admin",
"type": "accesscontrolrule",
"level": "view",
"properties": null
}
]
}

Response samples

application/json

{"status": "success",
"data": {"permissions": [{"id": 0,
"section": "system",
"type": "accesscontrolrule",
"level": "view",
"properties": null
}
]
}
}

Retrieve user permission

SecurityapiAuth

Request

path Parameters

identifier required	string^[a-zA-Z0-9\_\-]+$
permission_id required	string^\d+$

Responses

200

get/3/admin/users/{identifier}/permissions/{permission_id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.permissions.get(
  userId, {"id": permissionId}
).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"section": "system",
"type": "accesscontrolrule",
"level": "view",
"properties": null
}
}

users_permissions_update

SecurityapiAuth

Request

path Parameters

identifier required	string^[a-zA-Z0-9\_\-]+$
permission_id required	string^\d+$

Request Body schema:
application/json

properties

any or null

Responses

200

put/3/admin/users/{identifier}/permissions/{permission_id}/

Request samples

Payload

{"properties": null
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"section": "system",
"type": "accesscontrolrule",
"level": "view",
"properties": null
}
}

users_permissions_partial_update

SecurityapiAuth

Request

path Parameters

identifier required	string^[a-zA-Z0-9\_\-]+$
permission_id required	string^\d+$

Request Body schema:
application/json

properties

any or null

Responses

200

patch/3/admin/users/{identifier}/permissions/{permission_id}/

Request samples

Payload

{"properties": null
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"section": "system",
"type": "accesscontrolrule",
"level": "view",
"properties": null
}
}

Delete user permission

SecurityapiAuth

Request

path Parameters

identifier required	string^[a-zA-Z0-9\_\-]+$
permission_id required	string^\d+$

Responses

200

delete/3/admin/users/{identifier}/permissions/{permission_id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.permissions.delete(
  userId, permissionId
).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "sucess"
}

Retrieve user settings

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Responses

200

get/3/admin/users/{identifier}/settings/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.settings.get(
  userId
).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"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 settings

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Request Body schema:
application/json
required

allow_transactions	boolean
allow_debit_transactions	boolean
allow_credit_transactions	boolean
required	Array of objects (UpdateUserDisallowedTransactionSubtype)

Responses

200

put/3/admin/users/{identifier}/settings/

Request samples

Payload
Javascript SDK
Python SDK

{"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": 0,
"currency": "string"
}
]
}

Response samples

application/json

{"status": "success",
"data": {"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 settings

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Request Body schema:
application/json

allow_transactions	boolean
allow_debit_transactions	boolean
allow_credit_transactions	boolean
	Array of objects (UpdateUserDisallowedTransactionSubtype)

Responses

200

patch/3/admin/users/{identifier}/settings/

Request samples

Payload
Javascript SDK
Python SDK

{"allow_transactions": true,
"allow_debit_transactions": true,
"allow_credit_transactions": true,
"disallowed_transaction_subtypes": [{"subtype": 0,
"currency": "string"
}
]
}

Response samples

application/json

{"status": "success",
"data": {"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 users addresses

SecurityapiAuth

Request

query Parameters

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

Responses

200

get/3/admin/users/addresses/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.addresses.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,
"type": "permanent",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"archived": false,
"created": 0,
"updated": 0
}
]
}
}

Create user address

SecurityapiAuth

Request

Request Body schema:
application/json
required

type	string `permanent` - Permanent `contact` - Contact `shipping` - Shipping `billing` - Billing `business` - Business Enum: "permanent" "contact" "shipping" "billing" "business"
user required	string
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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false

Responses

201

post/3/admin/users/addresses/

Request samples

Payload
Javascript SDK
Python SDK

{"type": "permanent",
"user": "string",
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"archived": false,
"created": 0,
"updated": 0
}
}

Retrieve user address

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/addresses/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.addresses.get(
  {"id": addressId}
).then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"archived": false,
"created": 0,
"updated": 0
}
}

Update user 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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false

Responses

200

put/3/admin/users/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",
"status": "obsolete",
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"archived": false,
"created": 0,
"updated": 0
}
}

Partially update user 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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false

Responses

200

patch/3/admin/users/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",
"status": "obsolete",
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"type": "permanent",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"status": "obsolete",
"archived": false,
"created": 0,
"updated": 0
}
}

Delete user address

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/addresses/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.addresses.delete(
  addressId
).then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "sucess"
}

List users 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
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
status	string
user	string

Responses

200

get/3/admin/users/bank-accounts/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.bankAccounts.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,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}
}

Create user bank-account

SecurityapiAuth

Request

Request Body schema:
application/json
required

user required	string
name	string or null <= 200 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
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
bank_name	string or null <= 200 characters
bank_code	string or null <= 50 characters
branch_code	string or null <= 50 characters
	object (AdminUserBankBranchAddress) 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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
metadata	any or null
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

201

post/3/admin/users/bank-accounts/

Request samples

Payload
Javascript SDK
Python SDK

{"user": "string",
"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Retrieve users bank-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/bank-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.bankAccounts.get(
  {"id": accountId}
).then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Update user bank-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 200 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
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
bank_name	string or null <= 200 characters
bank_code	string or null <= 50 characters
branch_code	string or null <= 50 characters
	object (AdminUserBankBranchAddress) 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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
metadata	any or null
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

200

put/3/admin/users/bank-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Partially update user bank-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 200 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
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
bank_name	string or null <= 200 characters
bank_code	string or null <= 50 characters
branch_code	string or null <= 50 characters
	object (AdminUserBankBranchAddress) 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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
metadata	any or null
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

200

patch/3/admin/users/bank-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"name": "string",
"owner": {"first_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"
},
"number": "string",
"type": "string",
"beneficiary_type": "individual",
"clabe": "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",
"status": "obsolete",
"metadata": null,
"archived": false,
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Delete user bank-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/bank-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.bankAccounts.delete(
  accountId
).then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "sucess"
}

users_bank_accounts_account_currencies_list

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/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,
"archived": true
}
]
}

users_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/admin/users/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,
"archived": true
}
}

users_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/admin/users/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
}
}

users_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/admin/users/bank-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "sucess"
}

List user bank-account currencies

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/bank-accounts/{id}/currencies/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.bankAccounts.currencies.get(accountId)
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

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

Create user bank-account currency

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

currency

required

string

Responses

201

post/3/admin/users/bank-accounts/{id}/currencies/

Request samples

Payload
Javascript SDK
Python SDK

{"currency": "string"
}

Response samples

application/json

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

Retrieve user bank-account currency

SecurityapiAuth

Request

path Parameters

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

Responses

200

get/3/admin/users/bank-accounts/{id}/currencies/{code}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.bankAccounts.currencies.get(
  accountId, {"code": currencyCode)
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

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

Delete user bank-account currency

SecurityapiAuth

Request

path Parameters

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

Responses

200

delete/3/admin/users/bank-accounts/{id}/currencies/{code}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.bankAccounts.currencies.delete(
  accountId, currencyCode
).then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "sucess"
}

List users 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
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
status	string
user	string

Responses

200

get/3/admin/users/crypto-accounts/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.cryptoAccounts.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,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": null,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}
}

Create user 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"
metadata	any or null
user required	string
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

201

post/3/admin/users/crypto-accounts/

Request samples

Payload
Javascript SDK
Python SDK

{"address": "string",
"name": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": null,
"user": "string",
"status": "obsolete",
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": null,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Retrieve users crypto-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/crypto-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.cryptoAccounts.get(
  {"id": cryptoAccountId}
).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": null,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Update user 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"
metadata	any or null
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

200

put/3/admin/users/crypto-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"address": "string",
"name": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": null,
"status": "obsolete",
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": null,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Partially update user 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"
metadata	any or null
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

200

patch/3/admin/users/crypto-accounts/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"address": "string",
"name": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": null,
"status": "obsolete",
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"address": "string",
"name": "string",
"code": "string",
"crypto_type": "bitcoin",
"network": "testnet",
"metadata": null,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Delete user crypto-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/crypto-accounts/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.cryptoAccounts.delete(
  cryptoAccountId
).then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "sucess"
}

users_crypto_accounts_account_currencies_list

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/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,
"archived": true
}
]
}

users_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/admin/users/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,
"archived": true
}
}

users_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/admin/users/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
}
}

users_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/admin/users/crypto-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "sucess"
}

List user crypto-account currencies

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/crypto-accounts/{id}/currencies/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.cryptoAccounts.currencies.get(cryptoAccountId)
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "success",
"data": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com",
"archived": false,
"created": 0,
"updated": 0
}
]
}

Create user crypto-account currency

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

currency

required

string

Responses

201

post/3/admin/users/crypto-accounts/{id}/currencies/

Request samples

Payload
Javascript SDK
Python SDK

{"currency": "string"
}

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com",
"archived": false,
"created": 0,
"updated": 0
}
}

Retrieve user crypto-account currency

SecurityapiAuth

Request

path Parameters

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

Responses

200

get/3/admin/users/crypto-accounts/{id}/currencies/{code}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.cryptoAccounts.currencies.get(
  cryptoAccountId, {"code": currencyCode)
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "success",
"data": {"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com",
"archived": false,
"created": 0,
"updated": 0
}
}

Delete user crypto-account currency

SecurityapiAuth

Request

path Parameters

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

Responses

200

delete/3/admin/users/crypto-accounts/{id}/currencies/{code}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.cryptoAccounts.currencies.delete(
  cryptoAccountId, currencyCode
).then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "sucess"
}

List users devices

SecurityapiAuth

Request

query Parameters

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

Responses

200

get/3/admin/users/devices/

Request samples

Python SDK

rehive.admin.users.devices.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,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": null,
"archived": false,
"created": 0,
"updated": 0
}
]
}
}

Create user device

SecurityapiAuth

Request

Request Body schema:
application/json
required

user required	string
imei required	string <= 64 characters
name	string or null <= 30 characters
metadata	any or null
archived	boolean Default: false

Responses

201

post/3/admin/users/devices/

Request samples

Payload
Python SDK

{"user": "string",
"imei": "string",
"name": "string",
"metadata": null,
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": null,
"archived": false,
"created": 0,
"updated": 0
}
}

Retrieve users device app

SecurityapiAuth

Request

path Parameters

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

Responses

200

get/3/admin/users/devices/{device_id}/apps/{app_id}/

Request samples

Python SDK

rehive.admin.users.devices.obj(device_id).apps.get(app_id)

Response samples

application/json

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

Update user 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"
archived	boolean Default: false

Responses

200

put/3/admin/users/devices/{device_id}/apps/{app_id}/

Request samples

Payload
Python SDK

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

Response samples

application/json

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

Partially update user 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"
archived	boolean Default: false

Responses

200

patch/3/admin/users/devices/{device_id}/apps/{app_id}/

Request samples

Payload
Python SDK

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

Response samples

application/json

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

Delete user device

SecurityapiAuth

Request

path Parameters

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

Responses

200

delete/3/admin/users/devices/{device_id}/apps/{app_id}/

Request samples

Python SDK

rehive.admin.users.devices.obj.(device_id).delete(
  app_id
)

Response samples

application/json

{"status": "sucess"
}

Retrieve users device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/devices/{id}/

Request samples

Python SDK

rehive.admin.users.devices.get(device_id)

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": null,
"archived": false,
"created": 0,
"updated": 0
}
}

Update user device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 30 characters
metadata	any or null
archived	boolean Default: false

Responses

200

put/3/admin/users/devices/{id}/

Request samples

Payload
Python SDK

{"name": "string",
"metadata": null,
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": null,
"archived": false,
"created": 0,
"updated": 0
}
}

Partially update user device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

name	string or null <= 30 characters
metadata	any or null
archived	boolean Default: false

Responses

200

patch/3/admin/users/devices/{id}/

Request samples

Payload
Python SDK

{"name": "string",
"metadata": null,
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"imei": "string",
"name": "string",
"apps": [{"id": 0,
"name": "string",
"type": "expo",
"token": "string"
}
],
"metadata": null,
"archived": false,
"created": 0,
"updated": 0
}
}

Delete user device

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/devices/{id}/

Request samples

Python SDK

rehive.admin.users.devices.delete(device_id)

Response samples

application/json

{"status": "sucess"
}

List users 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/admin/users/devices/{id}/apps/

Request samples

Python SDK

rehive.admin.users.devices.obj(device_id).apps.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,
"name": "string",
"type": "expo",
"token": "string",
"archived": false,
"created": 0,
"updated": 0
}
]
}
}

Create users device apps

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
archived	boolean Default: false

Responses

201

post/3/admin/users/devices/{id}/apps/

Request samples

Payload
Python SDK

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

Response samples

application/json

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

List users documents

DEPRECATED: The document_type and document_category fields are deprecated.

SecurityapiAuth

Request

query Parameters

orderby	Array of strings Ordering `created` - Created `-created` - Created (descending) `updated` - Updated `-updated` - Updated (descending) `expires` - Expires `-expires` - Expires (descending) Items Enum: "-created" "-expires" "-updated" "created" "expires" "updated"
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
status	string
user	string

Responses

200

get/3/admin/users/documents/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.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,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": true,
"expires": 0,
"created": 0,
"updated": 0
}
]
}
}

Create users document

DEPRECATED: The document_type field is deprecated.

SecurityapiAuth

Request

Request Body schema:
application/json
required

user required	string
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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
metadata	any or null
note	string or null <= 250 characters
archived	boolean Default: false
expires	integer or null

Responses

201

post/3/admin/users/documents/

Request samples

Payload
Javascript SDK
Python SDK

{"user": "string",
"file": "http://example.com",
"document_type": "utility_bill",
"type": 0,
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": false,
"expires": 0
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": true,
"expires": 0,
"created": 0,
"updated": 0
}
}

Retrieve users document

DEPRECATED: The document_type and document_category fields are deprecated.

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/documents/{id}/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": true,
"expires": 0,
"created": 0,
"updated": 0
}
}

Update user document

DEPRECATED: The document_type field is deprecated.

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
metadata	any or null
note	string or null <= 250 characters
archived	boolean Default: false
expires	integer or null

Responses

200

put/3/admin/users/documents/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"document_type": "utility_bill",
"type": 0,
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": false,
"expires": 0
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": true,
"expires": 0,
"created": 0,
"updated": 0
}
}

Partially update user document

DEPRECATED: The document_type field is deprecated.

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

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
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
metadata	any or null
note	string or null <= 250 characters
archived	boolean Default: false
expires	integer or null

Responses

200

patch/3/admin/users/documents/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"document_type": "utility_bill",
"type": 0,
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": false,
"expires": 0
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"file": "http://example.com",
"document_category": "proof_of_address",
"document_type": "utility_bill",
"type": {"id": 0,
"name": "string",
"description": "string"
},
"status": "obsolete",
"metadata": null,
"note": "string",
"archived": true,
"expires": 0,
"created": 0,
"updated": 0
}
}

Delete user document

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/documents/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.documents.delete(documentId)
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "sucess"
}

List users emails

SecurityapiAuth

Request

query Parameters

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

Responses

200

get/3/admin/users/emails/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.emails.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": [{"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"archived": true,
"temporary": false,
"created": 0,
"updated": 0
}
]
}
}

Create users email

SecurityapiAuth

Request

Request Body schema:
application/json
required

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

Responses

201

post/3/admin/users/emails/

Request samples

Payload
Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"archived": true,
"temporary": false,
"created": 0,
"updated": 0
}
}

Retrieve users email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/emails/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.emails.get({"id": emailId})
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"archived": true,
"temporary": false,
"created": 0,
"updated": 0
}
}

Update users email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

primary	boolean
verified	boolean
archived	boolean

Responses

200

put/3/admin/users/emails/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true,
"verified": true,
"archived": true
}

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"archived": true,
"temporary": false,
"created": 0,
"updated": 0
}
}

Partially update users email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

primary	boolean
verified	boolean
archived	boolean

Responses

200

patch/3/admin/users/emails/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true,
"verified": true,
"archived": true
}

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"email": "user@example.com",
"primary": true,
"verified": true,
"archived": true,
"temporary": false,
"created": 0,
"updated": 0
}
}

Delete users email

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/emails/{id}/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "sucess"
}

List mfa authenticators

SecurityapiAuth

Request

query Parameters

id	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
type	string
user	string
verified	boolean

Responses

200

get/3/admin/users/mfa/authenticators/

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": "string",
"type": "totp",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"verified": true
}
]
}
}

Retrieve mfa authenticator

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Responses

200

get/3/admin/users/mfa/authenticators/{identifier}/

Response samples

application/json

{"status": "success",
"data": {"id": "string",
"type": "totp",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"verified": true
}
}

Delete mfa authenticator

SecurityapiAuth

Request

path Parameters

identifier

required

string^[a-zA-Z0-9\_\-]+$

Responses

200

delete/3/admin/users/mfa/authenticators/{identifier}/

Response samples

application/json

{"status": "sucess"
}

List users mobiles

SecurityapiAuth

Request

query Parameters

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

Responses

200

get/3/admin/users/mobiles/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.mobiles.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": [{"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"number": "string",
"primary": true,
"verified": true,
"archived": false,
"temporary": false,
"created": 0,
"updated": 0
}
]
}
}

Create users mobile

SecurityapiAuth

Request

Request Body schema:
application/json
required

user required	string
number required	string <= 24 characters
primary	boolean
verified	boolean
archived	boolean Default: false

Responses

201

post/3/admin/users/mobiles/

Request samples

Payload
Javascript SDK
Python SDK

{"user": "string",
"number": "string",
"primary": true,
"verified": true,
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"number": "string",
"primary": true,
"verified": true,
"archived": false,
"temporary": false,
"created": 0,
"updated": 0
}
}

Retrieve users mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/mobiles/{id}/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.mobiles.get({"id": mobileId})
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"number": "string",
"primary": true,
"verified": true,
"archived": false,
"temporary": false,
"created": 0,
"updated": 0
}
}

Update users mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

primary required	boolean
verified	boolean
archived	boolean Default: false

Responses

200

put/3/admin/users/mobiles/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true,
"verified": true,
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"number": "string",
"primary": true,
"verified": true,
"archived": false,
"temporary": false,
"created": 0,
"updated": 0
}
}

Partially update users mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

primary	boolean
verified	boolean
archived	boolean Default: false

Responses

200

patch/3/admin/users/mobiles/{id}/

Request samples

Payload
Javascript SDK
Python SDK

{"primary": true,
"verified": true,
"archived": false
}

Response samples

application/json

{"status": "success",
"data": {"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"id": 0,
"number": "string",
"primary": true,
"verified": true,
"archived": false,
"temporary": false,
"created": 0,
"updated": 0
}
}

Delete users mobile

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/mobiles/{id}/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "sucess"
}

Retrieve users overview

SecurityapiAuth

Responses

200

get/3/admin/users/overview/

Request samples

Javascript SDK
Python SDK

rehive.admin.users.overview.get()
.then(function (res) {
...
}, function (err) {
...
});

Response samples

application/json

{"status": "success",
"data": {"total": 0,
"archived": 0,
"active": 0
}
}

List users tokens

SecurityapiAuth

Request

query Parameters

created	string <date-time>
created__gt	string <date-time>
created__gte	string <date-time>
created__lt	string <date-time>
created__lte	string <date-time>
expires__isnull	boolean
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
token_key	string
token_key__exclude	string
token_key__in	string
user	string

Responses

200

get/3/admin/users/tokens/

Request samples

Python SDK

rehive.admin.users.tokens.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": [{"token_key": "string",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"expires": 0,
"created": 0
}
]
}
}

Create users token

SecurityapiAuth

Request

Request Body schema:
application/json
required

duration	integer or null >= 0
user required	string

Responses

201

post/3/admin/users/tokens/

Request samples

Payload
Python SDK

{"duration": 0,
"user": "string"
}

Response samples

application/json

{"status": "success",
"data": {"token_key": "string",
"token": "string",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"expires": 0,
"created": 0
}
}

Delete tokens

SecurityapiAuth

Responses

200

delete/3/admin/users/tokens/

Response samples

application/json

{"status": "sucess"
}

Retrieve users token

SecurityapiAuth

Request

path Parameters

token_key

required

string^\w+$

Responses

200

get/3/admin/users/tokens/{token_key}/

Request samples

Python SDK

rehive.admin.users.tokens.get(token_key)

Response samples

application/json

{"status": "success",
"data": {"token_key": "string",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"expires": 0,
"created": 0
}
}

Update users token

SecurityapiAuth

Request

path Parameters

token_key

required

string^\w+$

Request Body schema:
application/json
required

expires

required

integer >= 0

Responses

200

put/3/admin/users/tokens/{token_key}/

Request samples

Payload
Python SDK

{"expires": 0
}

Response samples

application/json

{"status": "success",
"data": {"token_key": "string",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"expires": 0,
"created": 0
}
}

Patially update users token

SecurityapiAuth

Request

path Parameters

token_key

required

string^\w+$

Request Body schema:
application/json

expires

integer >= 0

Responses

200

patch/3/admin/users/tokens/{token_key}/

Request samples

Payload
Python SDK

{"expires": 0
}

Response samples

application/json

{"status": "success",
"data": {"token_key": "string",
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"expires": 0,
"created": 0
}
}

Delete users token

SecurityapiAuth

Request

path Parameters

token_key

required

string^\w+$

Responses

200

delete/3/admin/users/tokens/{token_key}/

Request samples

Python SDK

rehive.admin.users.tokens.delete(
  token_key
)

Response samples

application/json

{"status": "sucess"
}

List users 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
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
status	string
user	string

Responses

200

get/3/admin/users/wallet-accounts/

Request samples

Python SDK

rehive.admin.users.wallet_accounts.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,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}
}

Create users wallet-accounts

SecurityapiAuth

Request

Request Body schema:
application/json
required

user required	string
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"
metadata	any or null
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

201

post/3/admin/users/wallet-accounts/

Request samples

Payload
Python SDK

{"user": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Retrieve users wallet-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/wallet-accounts/{id}/

Request samples

Python SDK

rehive.admin.users.wallet_accounts.get(wallet_account_id)

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Update users 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"
metadata	any or null
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

200

put/3/admin/users/wallet-accounts/{id}/

Request samples

Payload
Python SDK

{"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Partially update users wallte-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"
metadata	any or null
status	string `obsolete` - Obsolete `declined` - Declined `pending` - Pending `incomplete` - Incomplete `verified` - Verified Enum: "obsolete" "declined" "pending" "incomplete" "verified"
archived	boolean Default: false
action	string or null Default: "withdraw" `withdraw` - Withdraw `deposit` - Deposit Enum: "withdraw" "deposit" null

Responses

200

patch/3/admin/users/wallet-accounts/{id}/

Request samples

Payload
Python SDK

{"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"archived": false,
"action": "withdraw"
}

Response samples

application/json

{"status": "success",
"data": {"id": 0,
"user": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
},
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"code": "string",
"type": "paypal",
"metadata": null,
"status": "obsolete",
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"archived": false,
"action": "withdraw",
"created": 0,
"updated": 0
}
}

Delete users wallet-account

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/users/wallet-accounts/{id}/

Request samples

Python SDK

rehive.admin.users.wallet_accounts.delete(
  wallet_account_id,
  name='Changed name',
  # Other attributes.
)

Response samples

application/json

{"status": "sucess"
}

users_wallet_accounts_account_currencies_list

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/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,
"archived": true
}
]
}

users_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/admin/users/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,
"archived": true
}
}

users_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/admin/users/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
}
}

users_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/admin/users/wallet-accounts/{id}/account-currencies/{account_currency_id}/

Response samples

application/json

{"status": "sucess"
}

List users wallet-accounts currencies

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/users/wallet-accounts/{id}/currencies/

Response samples

application/json

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

Create users wallet-accounts currency

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

currency

required

string

Responses

201

post/3/admin/users/wallet-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,
"archived": false,
"created": 0,
"updated": 0
}
}

Retrieve users wallet-account currency

SecurityapiAuth

Request

path Parameters

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

Responses

200

get/3/admin/users/wallet-accounts/{id}/currencies/{code}/

Response samples

application/json

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

Delete users wallet-account currency

SecurityapiAuth

Request

path Parameters

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

Responses

200

delete/3/admin/users/wallet-accounts/{id}/currencies/{code}/

Response samples

application/json

{"status": "sucess"
}

➔ Next to wallet-accounts

users

List users

query Parameters

Create user

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

Retrieve user

path Parameters

Update user

path Parameters

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

Patially update user

path Parameters

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

List user groups

path Parameters

query Parameters

Create account definitions

path Parameters

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

Retrieve user group

path Parameters

Delete user group

path Parameters

List user legal-terms

path Parameters

query Parameters

Retrieve user legal-term

path Parameters

List user legal-term versions

path Parameters

query Parameters

Retrieve legal-term version

path Parameters

List user messages

path Parameters

query Parameters

Create user message

path Parameters

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

Retrieve user message

path Parameters

List user permissions

path Parameters

query Parameters

Create user permission

path Parameters

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

Retrieve user permission

path Parameters

users_permissions_update

path Parameters

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

users_permissions_partial_update

path Parameters

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

Delete user permission

path Parameters

Retrieve user settings

path Parameters

Update user settings

path Parameters

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

Partially update user settings

path Parameters

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

List users addresses

query Parameters

Create user address

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

Retrieve user address

path Parameters

Update user address

path Parameters

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

Partially update user address

path Parameters

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

Delete user address

path Parameters

List users bank-accounts

Request Body schema:
application/json

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

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json

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

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