auth

Retrieve auth

SecurityapiAuth

Responses

200

get/3/auth/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

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

Register company

SecurityNone

Request

Request Body schema:
application/json
required

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

Responses

201

post/3/auth/company/register/

Request samples

Payload
Javascript SDK
Python SDK

{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"company": {"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",
"public": true,
"metadata": {"property1": null,
"property2": null
},
"mode": "test",
"system_email": "user@example.com",
"links": ["string"
]
},
"id_number": "string",
"birth_date": "2019-08-24",
"language": "string",
"gender": "male",
"title": "mr",
"marital_status": "single",
"nationality": "AF",
"residency": "AF",
"timezone": "string",
"password": "string",
"password1": "string",
"password2": "string",
"terms_and_conditions": true,
"privacy_policy": true,
"legal_term_versions": [0
],
"auth_method": "cookie"
}

Response samples

application/json

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

Deactivate

SecurityNone

Request

Request Body schema:
application/json
required

user required	string
company required	string

Responses

200

post/3/auth/deactivate/

Request samples

Payload

{"user": "string",
"company": "string"
}

Response samples

application/json

{"status": "string"
}

Verify deactivation

SecurityNone

Request

Request Body schema:
application/json
required

key

required

string

Responses

200

post/3/auth/deactivate/verify/

Request samples

Payload

{"key": "string"
}

Response samples

application/json

{"status": "string"
}

Verify email

SecurityNone

Request

Request Body schema:
application/json
required

key

required

string

Responses

200

post/3/auth/email/verify/

Request samples

Payload

{"key": "string"
}

Response samples

application/json

{"status": "string"
}

Resend email verify

SecurityNone

Request

Request Body schema:
application/json
required

email required	string <email>
company required	string

Responses

200

post/3/auth/email/verify/resend/

Request samples

Payload

{"email": "user@example.com",
"company": "string"
}

Response samples

application/json

{"status": "string"
}

Login

SecurityNone

Request

Request Body schema:
application/json
required

user required	string
company required	string
password required	string <= 128 characters
session_duration	integer or null >= 0
auth_method	string Default: "token" `cookie` - Cookie `token` - Token Enum: "cookie" "token"

Responses

200

post/3/auth/login/

Request samples

Payload
Javascript SDK
Python SDK

{"user": "string",
"company": "string",
"password": "string",
"session_duration": 0,
"auth_method": "cookie"
}

Response samples

application/json

{"status": "string",
"data": {"token": "string",
"refresh_token": "string",
"user": {"id": "string"
},
"challenges": [{"id": "string",
"type": "authentication",
"durability": "ephemeral",
"authenticator_types": ["totp"
],
"created": 0
}
],
"expires": 0,
"created": 0
}
}

Logout

SecurityapiAuth

Request

Request Body schema:
application/json

clear_session_option

string

Default: "temporary"

all - All
temporary - Temporary
none - None

Enum: "all" "temporary" "none"

Responses

200

post/3/auth/logout/

Request samples

Payload
Javascript SDK
Python SDK

{"clear_session_option": "all"
}

Response samples

application/json

{"status": "string"
}

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
verified	boolean

Responses

200

get/3/auth/mfa/authenticators/

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": "string",
"type": "totp",
"details": {"name": "Default TOTP",
"algorithm": "SHA1",
"otpauth_url": "string",
"issuer": "string",
"account": "string",
"key": "string"
},
"verified": true,
"created": 0,
"updated": 0
}
]
}
}

Create MFA authenticator

SecurityapiAuth

Request

Request Body schema:
application/json
required

type

required

string

totp - Totp
sms - Sms
static - Static

Enum: "totp" "sms" "static"

Responses

201

post/3/auth/mfa/authenticators/

Request samples

Payload

{"type": "totp"
}

Response samples

application/json

{"status": "string",
"data": {"id": "string",
"type": "totp",
"details": {"name": "Default TOTP",
"algorithm": "SHA1",
"otpauth_url": "string",
"issuer": "string",
"account": "string",
"key": "string"
},
"verified": true,
"created": 0,
"updated": 0
}
}

Retreieve MFA authenticator

SecurityapiAuth

Request

path Parameters

identifier

required

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

Responses

200

get/3/auth/mfa/authenticators/{identifier}/

Response samples

application/json

{"status": "string",
"data": {"id": "string",
"type": "totp",
"details": {"name": "Default TOTP",
"algorithm": "SHA1",
"otpauth_url": "string",
"issuer": "string",
"account": "string",
"key": "string"
},
"verified": true,
"created": 0,
"updated": 0
}
}

Delete MFA authenticator

SecurityapiAuth

Request

path Parameters

identifier

required

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

Responses

200

delete/3/auth/mfa/authenticators/{identifier}/

Response samples

application/json

{"status": "string"
}

Deliver MFA

SecurityapiAuth

Request

Request Body schema:
application/json

challenge	string
authenticator	string

Responses

200

post/3/auth/mfa/deliver/

Request samples

Payload

{"challenge": "string",
"authenticator": "string"
}

Response samples

application/json

{"status": "string"
}

Verify MFA

SecurityapiAuth

Request

Request Body schema:
application/json
required

token required	string
challenge	string
authenticator	string

Responses

200

post/3/auth/mfa/verify/

Request samples

Payload

{"token": "string",
"challenge": "string",
"authenticator": "string"
}

Response samples

application/json

{"status": "string"
}

Verify mobile

SecurityapiAuth

Request

Request Body schema:
application/json
required

otp

required

string <= 24 characters

Responses

200

post/3/auth/mobile/verify/

Request samples

Payload

{"otp": "string"
}

Response samples

application/json

{"status": "string"
}

Resend mobile verify

SecurityNone

Request

Request Body schema:
application/json
required

mobile required	string
company required	string

Responses

200

post/3/auth/mobile/verify/resend/

Request samples

Payload

{"mobile": "string",
"company": "string"
}

Response samples

application/json

{"status": "string"
}

auth_oauth_authorize_create

SecurityNone

Request

Request Body schema:
application/json
required

session

required

string

Responses

201

post/3/auth/oauth/authorize/

Request samples

Payload

{"session": "string"
}

Response samples

application/json

{"status": "string",
"data": {"session": "string",
"url": "http://example.com"
}
}

auth_oauth_login_create

SecurityNone

Request

Request Body schema:
application/json
required

session required	string
session_duration	integer or null >= 0
auth_method	string Default: "token" `cookie` - Cookie `token` - Token Enum: "cookie" "token"

Responses

201

post/3/auth/oauth/login/

Request samples

Payload

{"session": "string",
"session_duration": 0,
"auth_method": "cookie"
}

Response samples

application/json

{"status": "string",
"data": {"token": "string",
"refresh_token": "string",
"user": {"id": "string"
},
"challenges": [{"id": "string",
"type": "authentication",
"durability": "ephemeral",
"authenticator_types": ["totp"
],
"created": 0
}
],
"expires": 0,
"created": 0
}
}

auth_oauth_register_create

SecurityNone

Request

Request Body schema:
application/json
required

session required	string
terms_and_conditions	boolean
privacy_policy	boolean
session_duration	integer or null >= 0
groups	Array of strings or null [ 0 .. 1 ] items
legal_term_versions	Array of integers >= 0 items
auth_method	string Default: "token" `cookie` - Cookie `token` - Token Enum: "cookie" "token"

Responses

201

post/3/auth/oauth/register/

Request samples

Payload

{"session": "string",
"terms_and_conditions": true,
"privacy_policy": true,
"session_duration": 0,
"groups": ["string"
],
"legal_term_versions": [0
],
"auth_method": "cookie"
}

Response samples

application/json

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

auth_oauth_session_create

SecurityNone

Request

Request Body schema:
application/json
required

client

required

string

Responses

201

post/3/auth/oauth/session/

Request samples

Payload

{"client": "string"
}

Response samples

application/json

{"status": "string",
"data": {"session": "string"
}
}

auth_oauth_verify_create

SecurityNone

Request

Request Body schema:
application/json

uri	string <uri>
code	string
session	string

Responses

201

post/3/auth/oauth/verify/

Request samples

Payload

{"uri": "http://example.com",
"code": "string",
"session": "string"
}

Response samples

application/json

{"status": "string",
"data": {"session": "string",
"user_exists": true
}
}

Change password

SecurityapiAuth

Request

Request Body schema:
application/json
required

old_password required	string <= 128 characters
new_password	string <= 128 characters
new_password1	string <= 128 characters Deprecated
new_password2	string <= 128 characters Deprecated
clear_session_option	string Default: "temporary" `all` - All `temporary` - Temporary `none` - None Enum: "all" "temporary" "none"

Responses

200

post/3/auth/password/change/

Request samples

Payload

{"old_password": "string",
"new_password": "string",
"new_password1": "string",
"new_password2": "string",
"clear_session_option": "all"
}

Response samples

application/json

{"status": "string"
}

Reset password

SecurityNone

Request

Request Body schema:
application/json
required

force	boolean Default: false
user required	string
company required	string

Responses

200

post/3/auth/password/reset/

Request samples

Payload

{"force": false,
"user": "string",
"company": "string"
}

Response samples

application/json

{"status": "string"
}

Confirm password reset

SecurityNone

Request

Request Body schema:
application/json
required

new_password	string <= 128 characters
new_password1	string <= 128 characters Deprecated
new_password2	string <= 128 characters Deprecated
uid required	string
token required	string
clear_session_option	string Default: "temporary" `all` - All `temporary` - Temporary `none` - None Enum: "all" "temporary" "none"

Responses

200

post/3/auth/password/reset/confirm/

Request samples

Payload

{"new_password": "string",
"new_password1": "string",
"new_password2": "string",
"uid": "string",
"token": "string",
"clear_session_option": "all"
}

Response samples

application/json

{"status": "string"
}

auth_refresh_create

SecurityapiRefreshAuth

Request

Request Body schema:
application/json

session_duration

integer or null >= 0

Responses

200

post/3/auth/refresh/

Request samples

Payload

{"session_duration": 0
}

Response samples

application/json

{"status": "string",
"data": {"refresh_token": "string",
"expires": 0,
"created": 0
}
}

Register

SecurityNone

Request

Request Body schema:
application/json
required

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

Responses

201

post/3/auth/register/

Request samples

Payload
Javascript SDK
Python SDK

{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"username": "string",
"email": "user@example.com",
"mobile": "string",
"company": "string",
"id_number": "string",
"birth_date": "2019-08-24",
"language": "string",
"gender": "male",
"title": "mr",
"marital_status": "single",
"nationality": "AF",
"residency": "AF",
"timezone": "string",
"password": "string",
"password1": "string",
"password2": "string",
"terms_and_conditions": true,
"privacy_policy": true,
"session_duration": 0,
"groups": ["string"
],
"legal_term_versions": [0
],
"auth_method": "cookie"
}

Response samples

application/json

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

Request delete

SecurityNone

Request

Request Body schema:
application/json
required

user required	string
company required	string

Responses

200

post/3/auth/request-delete/

Request samples

Payload

{"user": "string",
"company": "string"
}

Response samples

application/json

{"status": "string"
}

Verify request delete

SecurityNone

Request

Request Body schema:
application/json
required

key

required

string

Responses

200

post/3/auth/request-delete/verify/

Request samples

Payload

{"key": "string"
}

Response samples

application/json

{"status": "string"
}

List auth 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
token_key	string
token_key__exclude	string
token_key__in	string

Responses

200

get/3/auth/tokens/

Response samples

application/json

{"status": "string",
"data": [{"token_key": "string",
"expires": 0,
"created": 0
}
]
}

Create auth token

SecurityapiAuth

Request

Request Body schema:
application/json
required

password required	string <= 128 characters
duration	integer or null >= 0

Responses

201

post/3/auth/tokens/

Request samples

Payload

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

Response samples

application/json

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

Delete auth tokens

SecurityapiAuth

Responses

200

delete/3/auth/tokens/

Response samples

application/json

{"status": "string"
}

Retrieve auth token

SecurityapiAuth

Request

path Parameters

token_key

required

string^\w+$

Responses

200

get/3/auth/tokens/{token_key}/

Response samples

application/json

{"status": "string",
"data": {"token_key": "string",
"expires": 0,
"created": 0
}
}

Delete auth token

SecurityapiAuth

Request

path Parameters

token_key

required

string^\w+$

Responses

200

delete/3/auth/tokens/{token_key}/

Response samples

application/json

{"status": "string"
}

➔ Next to company

auth

Retrieve auth

Register company

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

Deactivate

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

Verify deactivation

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

Verify email

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

Resend email verify

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

Login

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

Logout

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

List MFA authenticators

query Parameters

Create MFA authenticator

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

Retreieve MFA authenticator

path Parameters

Delete MFA authenticator

path Parameters

Deliver MFA

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

Verify MFA

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

Verify mobile

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

Resend mobile verify

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

auth_oauth_authorize_create

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

auth_oauth_login_create

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

auth_oauth_register_create

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

auth_oauth_session_create

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

auth_oauth_verify_create

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

Change password

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

Reset password

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

Confirm password reset

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

auth_refresh_create

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

Register

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

Request delete

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

Verify request delete

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

List auth tokens

query Parameters

Create auth token

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

Delete auth tokens

Retrieve auth token

path Parameters

Delete auth token

path Parameters

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
required

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
required

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
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required