company

Retrieve company

SecurityapiAuth

Responses

200

get/3/admin/company/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "string",
"data": {"id": "string",
"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "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"
}
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
},
"services": [{"id": 0,
"slug": "string",
"name": "string",
"url": "string",
"type": "system"
}
],
"public": true,
"metadata": {"property1": null,
"property2": null
},
"mode": "test",
"status": "pending",
"created": 0,
"updated": 0,
"system_email": "user@example.com",
"owner": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
}
}
}

Update company

SecurityapiAuth

Request

Request Body schema:
application/json
required

name	string or null <= 100 characters
description	string or null <= 255 characters
website	string or null <uri> <= 200 characters
support_website	string or null <uri> <= 200 characters
documentation_website	string or null <uri> <= 200 characters
support_email	string or null <email> <= 254 characters
contact_email	string or null <email> <= 254 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
logo	string or null <uri>
icon	string or null <uri>
public	boolean
	object or null
status	string `pending` - Pending `active` - Active `restricted` - Restricted `suspended` - Suspended Enum: "pending" "active" "restricted" "suspended"
system_email required	string <email>

Responses

200

put/3/admin/company/

Request samples

Payload
Javascript SDK
Python SDK

{"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"public": true,
"metadata": {"property1": null,
"property2": null
},
"status": "pending",
"system_email": "user@example.com"
}

Response samples

application/json

{"status": "string",
"data": {"id": "string",
"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "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"
}
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
},
"services": [{"id": 0,
"slug": "string",
"name": "string",
"url": "string",
"type": "system"
}
],
"public": true,
"metadata": {"property1": null,
"property2": null
},
"mode": "test",
"status": "pending",
"created": 0,
"updated": 0,
"system_email": "user@example.com",
"owner": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
}
}
}

Partilly update company

SecurityapiAuth

Request

Request Body schema:
application/json

name	string or null <= 100 characters
description	string or null <= 255 characters
website	string or null <uri> <= 200 characters
support_website	string or null <uri> <= 200 characters
documentation_website	string or null <uri> <= 200 characters
support_email	string or null <email> <= 254 characters
contact_email	string or null <email> <= 254 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
logo	string or null <uri>
icon	string or null <uri>
public	boolean
	object or null
status	string `pending` - Pending `active` - Active `restricted` - Restricted `suspended` - Suspended Enum: "pending" "active" "restricted" "suspended"
system_email	string <email>

Responses

200

patch/3/admin/company/

Request samples

Payload
Javascript SDK
Python SDK

{"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"public": true,
"metadata": {"property1": null,
"property2": null
},
"status": "pending",
"system_email": "user@example.com"
}

Response samples

application/json

{"status": "string",
"data": {"id": "string",
"name": "string",
"description": "string",
"website": "http://example.com",
"support_website": "http://example.com",
"documentation_website": "http://example.com",
"support_email": "user@example.com",
"contact_email": "user@example.com",
"country": "AF",
"logo": "http://example.com",
"icon": "http://example.com",
"address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "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"
}
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
},
"services": [{"id": 0,
"slug": "string",
"name": "string",
"url": "string",
"type": "system"
}
],
"public": true,
"metadata": {"property1": null,
"property2": null
},
"mode": "test",
"status": "pending",
"created": 0,
"updated": 0,
"system_email": "user@example.com",
"owner": {"id": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"profile": "http://example.com",
"groups": [{"name": "string",
"label": "string",
"section": "system"
}
],
"temporary": true
}
}
}

Retrieve company address

SecurityapiAuth

Responses

200

get/3/admin/company/address/

Request samples

Javascript SDK
Python SDK

rehive.admin.company.address.get().then(function (res) {
    ...
}, function (err) {
    ...
});

Response samples

application/json

{"status": "string",
"data": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "string"
}
}

Update company addresses

SecurityapiAuth

Request

Request Body schema:
application/json

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
postal_code	string or null <= 10 characters

Responses

200

put/3/admin/company/address/

Request samples

Payload
Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "string",
"data": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "string"
}
}

Partially update company addresses

SecurityapiAuth

Request

Request Body schema:
application/json

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
postal_code	string or null <= 10 characters

Responses

200

patch/3/admin/company/address/

Request samples

Payload
Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "string",
"data": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "string",
"postal_code": "string"
}
}

List company links

SecurityapiAuth

Request

query Parameters

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

Responses

200

get/3/admin/company/links/

Request samples

Python SDK

rehive.admin.company.links.get()

Response samples

application/json

{"status": "string",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"key": "string",
"counterparty": {"company": {"id": "string",
"name": "string",
"icon": "http://example.com",
"mode": "test"
},
"status": "pending"
},
"status": "pending",
"created": 0,
"updated": 0
}
]
}
}

Create company link

SecurityapiAuth

Request

Request Body schema:
application/json

key	string
company	string

Responses

201

post/3/admin/company/links/

Request samples

Payload
Python SDK

{"key": "string",
"company": "string"
}

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"key": "string",
"counterparty": {"company": {"id": "string",
"name": "string",
"icon": "http://example.com",
"mode": "test"
},
"status": "pending"
},
"status": "pending",
"created": 0,
"updated": 0
}
}

Retrieve company link

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

get/3/admin/company/links/{id}/

Request samples

Python SDK

rehive.admin.company.links.get(
  link_id
)

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"key": "string",
"counterparty": {"company": {"id": "string",
"name": "string",
"icon": "http://example.com",
"mode": "test"
},
"status": "pending"
},
"status": "pending",
"created": 0,
"updated": 0
}
}

Update company link

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json
required

status

required

string

complete - Complete

Value: "complete"

Responses

200

put/3/admin/company/links/{id}/

Request samples

Payload
Python SDK

{"status": "complete"
}

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"key": "string",
"counterparty": {"company": {"id": "string",
"name": "string",
"icon": "http://example.com",
"mode": "test"
},
"status": "pending"
},
"status": "pending",
"created": 0,
"updated": 0
}
}

Partially update company link

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Request Body schema:
application/json

status

string

complete - Complete

Value: "complete"

Responses

200

patch/3/admin/company/links/{id}/

Request samples

Payload
Python SDK

{"status": "complete"
}

Response samples

application/json

{"status": "string",
"data": {"id": 0,
"key": "string",
"counterparty": {"company": {"id": "string",
"name": "string",
"icon": "http://example.com",
"mode": "test"
},
"status": "pending"
},
"status": "pending",
"created": 0,
"updated": 0
}
}

Delete company link

SecurityapiAuth

Request

path Parameters

required

string^\d+$

Responses

200

delete/3/admin/company/links/{id}/

Request samples

Python SDK

rehive.admin.company.links.delete(
  link_id
)

Response samples

application/json

{"status": "string"
}

Retrieve company settings

SecurityapiAuth

Responses

200

get/3/admin/company/settings/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

{"status": "string",
"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"
}
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
}
}

Update company settings

SecurityapiAuth

Request

Request Body schema:
application/json
required

allow_transactions	boolean
allow_debit_transactions	boolean
allow_credit_transactions	boolean
required	Array of objects (UpdateCompanyDisallowedTransactionSubtype)
require_transaction_subtypes	boolean
require_verification	boolean
allow_registrations	boolean
allow_overdrafts	boolean
allow_session_durations	boolean
require_registration	boolean
default_session_duration	integer [ 300 .. 2678400 ]
default_transaction_lifespan	integer [ 300 .. 2678400 ]
require_terms_and_conditions	boolean
require_privacy_policy	boolean
account_reference_length	integer [ -2147483648 .. 2147483647 ]
password_reset_url	string or null <uri>
password_set_url	string or null <uri>
email_verification_url	string or null <uri>
deactivate_verification_url	string or null <uri>
request_delete_verification_url	string or null <uri>
terms_and_conditions_url	string or null <uri>
privacy_policy_url	string or null <uri>
nationalities required	Array of strings <= 249 items Items 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"
residencies required	Array of strings <= 249 items Items 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"

Responses

200

put/3/admin/company/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"
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
}

Response samples

application/json

{"status": "string",
"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"
}
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
}
}

Partially update company settings

SecurityapiAuth

Request

Request Body schema:
application/json

allow_transactions	boolean
allow_debit_transactions	boolean
allow_credit_transactions	boolean
	Array of objects (UpdateCompanyDisallowedTransactionSubtype)
require_transaction_subtypes	boolean
require_verification	boolean
allow_registrations	boolean
allow_overdrafts	boolean
allow_session_durations	boolean
require_registration	boolean
default_session_duration	integer [ 300 .. 2678400 ]
default_transaction_lifespan	integer [ 300 .. 2678400 ]
require_terms_and_conditions	boolean
require_privacy_policy	boolean
account_reference_length	integer [ -2147483648 .. 2147483647 ]
password_reset_url	string or null <uri>
password_set_url	string or null <uri>
email_verification_url	string or null <uri>
deactivate_verification_url	string or null <uri>
request_delete_verification_url	string or null <uri>
terms_and_conditions_url	string or null <uri>
privacy_policy_url	string or null <uri>
nationalities	Array of strings <= 249 items Items 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"
residencies	Array of strings <= 249 items Items 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"

Responses

200

patch/3/admin/company/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"
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
}

Response samples

application/json

{"status": "string",
"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"
}
}
],
"require_transaction_subtypes": true,
"require_verification": true,
"allow_registrations": true,
"allow_overdrafts": true,
"allow_session_durations": true,
"require_registration": true,
"default_session_duration": 300,
"default_transaction_lifespan": 300,
"require_terms_and_conditions": true,
"require_privacy_policy": true,
"account_reference_length": -2147483648,
"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",
"terms_and_conditions_url": "http://example.com",
"privacy_policy_url": "http://example.com",
"nationalities": ["AF"
],
"residencies": ["AF"
]
}
}

➔ Next to currencies

company

Retrieve company

Update company

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

Partilly update company

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

Retrieve company address

Update company addresses

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

Partially update company addresses

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

List company links

query Parameters

Create company link

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

Retrieve company link

path Parameters

Update company link

path Parameters

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

Partially update company link

path Parameters

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

Delete company link

path Parameters

Retrieve company settings

Update company settings

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

Partially update company settings

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

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json