company

Retrieve company

SecurityapiAuth

Responses

200

get/3/company/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

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

List bank accounts

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>
currency	string
id	string
name	string
name__contains	string
number	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/company/bank-accounts/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"name": "string",
"number": "string",
"type": "string",
"bank_name": "string",
"bank_code": "string",
"branch_code": "string",
"branch_address": {"line_1": "string",
"line_2": "string",
"city": "string",
"state_province": "string",
"country": "AF",
"postal_code": "string",
"state_code": "string"
},
"routing_number": "string",
"swift": "string",
"iban": "string",
"bic": "string",
"metadata": {"property1": null,
"property2": null
},
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}
}

List currencies

SecurityapiAuth

Request

query Parameters

code	string
code__in	string
display_code	string
orderby	Array of strings Ordering `created` - Created `-created` - Created (descending) `code` - Code `-code` - Code (descending) `display_code` - Display code `-display_code` - Display code (descending) Items Enum: "-code" "-created" "-display_code" "code" "created" "display_code"
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.
unit	string

Responses

200

get/3/company/currencies/

Request samples

Javascript SDK
Python SDK

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

Response samples

application/json

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

Retrieve currency

SecurityapiAuth

Request

path Parameters

code

required

string^\w+$

Responses

200

get/3/company/currencies/{code}/

Request samples

Javascript SDK
Python SDK

rehive.company.currencies.get({code: code}).then(function(res){
    ...
}, function(err){
    ...
})

Response samples

application/json

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

List wallet accounts

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>
currency	string
id	string
name	string
name__contains	string
page	integer A page number within the paginated result set.
page_size	integer Number of results to return per page.

Responses

200

get/3/company/wallet-accounts/

Response samples

application/json

{"status": "success",
"data": {"count": 123,
"next": "http://api.example.org/accounts/?page=4",
"previous": "http://api.example.org/accounts/?page=2",
"results": [{"id": 0,
"username": "string",
"email": "user@example.com",
"mobile": "string",
"name": "string",
"type": "paypal",
"metadata": {"property1": null,
"property2": null
},
"currencies": [{"code": "string",
"display_code": "string",
"description": "string",
"symbol": "string",
"unit": "string",
"divisibility": -2147483648,
"icon": "http://example.com"
}
],
"action": "withdraw",
"created": 0,
"updated": 0
}
]
}
}

➔ Next to document-types