Asset Portal

Postman collection → OpenAPI spec →

Introduction

The Official Standard Life Organization API for the management of assets and their depreciation value over time

Base URL: https://assetapi.insuretech.com.ng

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Accounts

Get A Listing Of Accounts

GET

https://assetapi.insuretech.com.ng

/api/v1/accounts

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

integer

Search For An Account.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/accounts?query=0" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create A New Account.

POST

https://assetapi.insuretech.com.ng

/api/v1/accounts

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

gl_code

string

required

The Unique GL Code to Identify the account.

Example:

ullam

name

string

required

The name of the Account.

Example:

sit

description

string

required

The description of the Account

Example:

Ullam rerum harum dolor modi.

type

string

required

The type of Account.

Example:

asset

Auth

Bearer

Headers

Body

{ "gl_code": "ullam", "name": "sit", "description": "Ullam rerum harum dolor modi.", "type": "asset" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/accounts" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"gl_code\": \"ullam\",
    \"name\": \"sit\",
    \"description\": \"Ullam rerum harum dolor modi.\",
    \"type\": \"asset\"
}"

Retrieve An Account's Details.

GET

https://assetapi.insuretech.com.ng

/api/v1/accounts/{account_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

account_id

string

required

The ID of the account.

Example:

mollitia

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/accounts/mollitia" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update An Account's Details.

PUT

https://assetapi.insuretech.com.ng

/api/v1/accounts/{account_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

account_id

string

required

The ID of the account.

Example:

aspernatur

Body Parameters

gl_code

string

required

The Unique GL Code to Identify the account.

Example:

possimus

name

string

required

The name of the Account.

Example:

reprehenderit

description

string

required

The description of the Account

Example:

Molestiae sapiente sit tempore exercitationem id.

type

string

required

The type of Account.

Example:

asset

Auth

Bearer

Headers

URL Parameters

Body

{ "gl_code": "possimus", "name": "reprehenderit", "description": "Molestiae sapiente sit tempore exercitationem id.", "type": "asset" }

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/accounts/aspernatur" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"gl_code\": \"possimus\",
    \"name\": \"reprehenderit\",
    \"description\": \"Molestiae sapiente sit tempore exercitationem id.\",
    \"type\": \"asset\"
}"

Destroy An Account.

DELETE

https://assetapi.insuretech.com.ng

/api/v1/accounts/{account_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

account_id

string

required

The ID of the account.

Example:

possimus

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://assetapi.insuretech.com.ng/api/v1/accounts/possimus" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Asset Categories

Get List Of Asset Categories.

GET

https://assetapi.insuretech.com.ng

/api/v1/asset-categories

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Search An Asset Category.

Example:

Test

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/asset-categories?query=Test" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Add a New Asset Category

POST

https://assetapi.insuretech.com.ng

/api/v1/asset-categories

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

required

The name of the Asset Category.

Example:

provident

description

required

The decription of the Asset Category

Example:

Animi unde voluptatem praesentium est nostrum.

Auth

Bearer

Headers

Body

{ "name": "provident", "description": "Animi unde voluptatem praesentium est nostrum." }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/asset-categories" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"provident\",
    \"description\": \"Animi unde voluptatem praesentium est nostrum.\"
}"

Get A Single Asset Category's Details.

GET

https://assetapi.insuretech.com.ng

/api/v1/asset-categories/{category_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

category_slug

integer

required

The slug of the category.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/asset-categories/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update An Asset Category's Details.

PUT

https://assetapi.insuretech.com.ng

/api/v1/asset-categories/{category_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

category_slug

integer

required

The slug of the category.

Example:

Body Parameters

name

required

The name of the Asset Category.

Example:

earum

description

required

The decription of the Asset Category

Example:

Nam deleniti ut enim autem est minima quia consequatur.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "earum", "description": "Nam deleniti ut enim autem est minima quia consequatur." }

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/asset-categories/8" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"earum\",
    \"description\": \"Nam deleniti ut enim autem est minima quia consequatur.\"
}"

Remove the specified resource from storage.

DELETE

https://assetapi.insuretech.com.ng

/api/v1/asset-categories/{category_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

category_slug

integer

required

The slug of the category.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://assetapi.insuretech.com.ng/api/v1/asset-categories/11" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Assets

Get A Listing of Assets

GET

https://assetapi.insuretech.com.ng

/api/v1/assets

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Search An Asset Within Office.

Example:

Test

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/assets?query=Test" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create New Asset

POST

https://assetapi.insuretech.com.ng

/api/v1/assets

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

office_id

string

required

Example:

category_id

string

required

Example:

iusto

asset_account_id

string

required

Example:

nihil

expense_account_id

string

required

Example:

eos

image

file

required

Must be an image.

Example:

C:\Users\ranke\AppData\Local\Temp\php7AED.tmp

proof_of_purchase

file

required

Must be a file.

Example:

C:\Users\ranke\AppData\Local\Temp\php7AFE.tmp

name

string

required

Example:

error

serial_number

string

Example:

non

brand

string

required

Example:

ipsam

model

string

Example:

rerum

vendor

string

required

Example:

atque

vendor_phone

string

required

Example:

sed

vendor_address

string

Example:

odit

description

string

required

Must not be greater than 5000 characters.

Example:

Quis hic ducimus corporis animi voluptate.

cost

number

required

Example:

0.00706

purchase_date

string

required

Must be a valid date.

Example:

2025-04-24T17:27:17

warranty_duration

integer

required

Example:

warranty_expiry_date

string

required

Must be a valid date.

Example:

2025-04-24T17:27:17

additional_form

string

depreciation_rate

number

required

Example:

2101903

depreciation_duration

integer

required

Must be at least 1.

Example:

final_year_depreciation_rate

number

required

Example:

374502.3471

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "office_id=et"\
    --form "category_id=iusto"\
    --form "asset_account_id=nihil"\
    --form "expense_account_id=eos"\
    --form "name=error"\
    --form "serial_number=non"\
    --form "brand=ipsam"\
    --form "model=rerum"\
    --form "vendor=atque"\
    --form "vendor_phone=sed"\
    --form "vendor_address=odit"\
    --form "description=Quis hic ducimus corporis animi voluptate."\
    --form "cost=0.00706"\
    --form "purchase_date=2025-04-24T17:27:17"\
    --form "warranty_duration=8"\
    --form "warranty_expiry_date=2025-04-24T17:27:17"\
    --form "depreciation_rate=2101903"\
    --form "depreciation_duration=76"\
    --form "final_year_depreciation_rate=374502.3471"\
    --form "image=@C:\Users\ranke\AppData\Local\Temp\php7AED.tmp" \
    --form "proof_of_purchase=@C:\Users\ranke\AppData\Local\Temp\php7AFE.tmp"

$client = new \GuzzleHttp\Client();
$url = 'https://assetapi.insuretech.com.ng/api/v1/assets';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'office_id',
                'contents' => 'et'
            ],
            [
                'name' => 'category_id',
                'contents' => 'iusto'
            ],
            [
                'name' => 'asset_account_id',
                'contents' => 'nihil'
            ],
            [
                'name' => 'expense_account_id',
                'contents' => 'eos'
            ],
            [
                'name' => 'name',
                'contents' => 'error'
            ],
            [
                'name' => 'serial_number',
                'contents' => 'non'
            ],
            [
                'name' => 'brand',
                'contents' => 'ipsam'
            ],
            [
                'name' => 'model',
                'contents' => 'rerum'
            ],
            [
                'name' => 'vendor',
                'contents' => 'atque'
            ],
            [
                'name' => 'vendor_phone',
                'contents' => 'sed'
            ],
            [
                'name' => 'vendor_address',
                'contents' => 'odit'
            ],
            [
                'name' => 'description',
                'contents' => 'Quis hic ducimus corporis animi voluptate.'
            ],
            [
                'name' => 'cost',
                'contents' => '0.00706'
            ],
            [
                'name' => 'purchase_date',
                'contents' => '2025-04-24T17:27:17'
            ],
            [
                'name' => 'warranty_duration',
                'contents' => '8'
            ],
            [
                'name' => 'warranty_expiry_date',
                'contents' => '2025-04-24T17:27:17'
            ],
            [
                'name' => 'depreciation_rate',
                'contents' => '2101903'
            ],
            [
                'name' => 'depreciation_duration',
                'contents' => '76'
            ],
            [
                'name' => 'final_year_depreciation_rate',
                'contents' => '374502.3471'
            ],
            [
                'name' => 'image',
                'contents' => fopen('C:\Users\ranke\AppData\Local\Temp\php7AED.tmp', 'r')
            ],
            [
                'name' => 'proof_of_purchase',
                'contents' => fopen('C:\Users\ranke\AppData\Local\Temp\php7AFE.tmp', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Get All Vendors From Assets

GET

https://assetapi.insuretech.com.ng

/api/v1/assets/vendors

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/assets/vendors" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get An Asset's Details

GET

https://assetapi.insuretech.com.ng

/api/v1/assets/{asset_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/assets/architecto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update An Asset's Details

POST

https://assetapi.insuretech.com.ng

/api/v1/assets/{asset_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

harum

Body Parameters

office_id

string

required

Example:

veritatis

category_id

string

required

Example:

quos

asset_account_id

string

required

Example:

aliquam

expense_account_id

string

required

Example:

quis

image

file

required

Must be an image.

Example:

C:\Users\ranke\AppData\Local\Temp\php7B4F.tmp

proof_of_purchase

file

required

Must be a file.

Example:

C:\Users\ranke\AppData\Local\Temp\php7B50.tmp

name

string

required

Example:

sunt

serial_number

string

Example:

aut

brand

string

required

Example:

exercitationem

model

string

Example:

molestiae

vendor

string

required

Example:

rerum

vendor_phone

string

required

Example:

voluptatem

vendor_address

string

Example:

corporis

description

string

required

Must not be greater than 5000 characters.

Example:

Minima sed et minima consequuntur esse eos velit.

cost

number

required

Example:

358235277.8

purchase_date

string

required

Must be a valid date.

Example:

2025-04-24T17:27:17

warranty_duration

integer

required

Example:

warranty_expiry_date

string

required

Must be a valid date.

Example:

2025-04-24T17:27:17

additional_form

string

depreciation_rate

number

required

Example:

1940610.403

depreciation_duration

integer

required

Must be at least 1.

Example:

final_year_depreciation_rate

number

required

Example:

1796.6494

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets/harum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "office_id=veritatis"\
    --form "category_id=quos"\
    --form "asset_account_id=aliquam"\
    --form "expense_account_id=quis"\
    --form "name=sunt"\
    --form "serial_number=aut"\
    --form "brand=exercitationem"\
    --form "model=molestiae"\
    --form "vendor=rerum"\
    --form "vendor_phone=voluptatem"\
    --form "vendor_address=corporis"\
    --form "description=Minima sed et minima consequuntur esse eos velit."\
    --form "cost=358235277.8"\
    --form "purchase_date=2025-04-24T17:27:17"\
    --form "warranty_duration=20"\
    --form "warranty_expiry_date=2025-04-24T17:27:17"\
    --form "depreciation_rate=1940610.403"\
    --form "depreciation_duration=64"\
    --form "final_year_depreciation_rate=1796.6494"\
    --form "image=@C:\Users\ranke\AppData\Local\Temp\php7B4F.tmp" \
    --form "proof_of_purchase=@C:\Users\ranke\AppData\Local\Temp\php7B50.tmp"

$client = new \GuzzleHttp\Client();
$url = 'https://assetapi.insuretech.com.ng/api/v1/assets/harum';
$response = $client->post(
    $url,
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'multipart/form-data',
            'Accept' => 'application/json',
        ],
        'multipart' => [
            [
                'name' => 'office_id',
                'contents' => 'veritatis'
            ],
            [
                'name' => 'category_id',
                'contents' => 'quos'
            ],
            [
                'name' => 'asset_account_id',
                'contents' => 'aliquam'
            ],
            [
                'name' => 'expense_account_id',
                'contents' => 'quis'
            ],
            [
                'name' => 'name',
                'contents' => 'sunt'
            ],
            [
                'name' => 'serial_number',
                'contents' => 'aut'
            ],
            [
                'name' => 'brand',
                'contents' => 'exercitationem'
            ],
            [
                'name' => 'model',
                'contents' => 'molestiae'
            ],
            [
                'name' => 'vendor',
                'contents' => 'rerum'
            ],
            [
                'name' => 'vendor_phone',
                'contents' => 'voluptatem'
            ],
            [
                'name' => 'vendor_address',
                'contents' => 'corporis'
            ],
            [
                'name' => 'description',
                'contents' => 'Minima sed et minima consequuntur esse eos velit.'
            ],
            [
                'name' => 'cost',
                'contents' => '358235277.8'
            ],
            [
                'name' => 'purchase_date',
                'contents' => '2025-04-24T17:27:17'
            ],
            [
                'name' => 'warranty_duration',
                'contents' => '20'
            ],
            [
                'name' => 'warranty_expiry_date',
                'contents' => '2025-04-24T17:27:17'
            ],
            [
                'name' => 'depreciation_rate',
                'contents' => '1940610.403'
            ],
            [
                'name' => 'depreciation_duration',
                'contents' => '64'
            ],
            [
                'name' => 'final_year_depreciation_rate',
                'contents' => '1796.6494'
            ],
            [
                'name' => 'image',
                'contents' => fopen('C:\Users\ranke\AppData\Local\Temp\php7B4F.tmp', 'r')
            ],
            [
                'name' => 'proof_of_purchase',
                'contents' => fopen('C:\Users\ranke\AppData\Local\Temp\php7B50.tmp', 'r')
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Transfer An Asset

POST

https://assetapi.insuretech.com.ng

/api/v1/assets/transfer/{asset_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

Body Parameters

office_id

string

required

Example:

staff_id

string

required

Example:

reprehenderit

note

string

Must not be greater than 4000 characters.

Example:

uiio

Auth

Bearer

Headers

URL Parameters

Body

{ "office_id": "et", "staff_id": "reprehenderit", "note": "uiio" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets/transfer/et" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"office_id\": \"et\",
    \"staff_id\": \"reprehenderit\",
    \"note\": \"uiio\"
}"

Dispatch An Asset

POST

https://assetapi.insuretech.com.ng

/api/v1/assets/dispatch/{asset_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

quod

Body Parameters

office_id

string

required

Example:

reprehenderit

staff_id

string

required

Example:

ullam

condition

string

required

Must be one of:

new
replacement
temporary

Example:

temporary

note

string

Must not be greater than 4000 characters.

Example:

xvfeeiyfjtemfvxnrqacr

Auth

Bearer

Headers

URL Parameters

Body

{ "office_id": "reprehenderit", "staff_id": "ullam", "condition": "temporary", "note": "xvfeeiyfjtemfvxnrqacr" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets/dispatch/quod" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"office_id\": \"reprehenderit\",
    \"staff_id\": \"ullam\",
    \"condition\": \"temporary\",
    \"note\": \"xvfeeiyfjtemfvxnrqacr\"
}"

Mark an asset as repairs or damaged

POST

https://assetapi.insuretech.com.ng

/api/v1/assets/mark/{asset_slug}/damaged

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

suscipit

Body Parameters

office_id

string

required

Example:

neque

staff_id

string

required

Example:

sequi

note

string

Must not be greater than 4000 characters.

Example:

deojosgsp

Auth

Bearer

Headers

URL Parameters

Body

{ "office_id": "neque", "staff_id": "sequi", "note": "deojosgsp" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets/mark/suscipit/damaged" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"office_id\": \"neque\",
    \"staff_id\": \"sequi\",
    \"note\": \"deojosgsp\"
}"

Mark an asset as repairs or damaged

POST

https://assetapi.insuretech.com.ng

/api/v1/assets/mark/{asset_slug}/repairs

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

autem

Body Parameters

office_id

string

required

Example:

suscipit

staff_id

string

required

Example:

nostrum

note

string

Must not be greater than 4000 characters.

Example:

rtonzhbhmajoeah

Auth

Bearer

Headers

URL Parameters

Body

{ "office_id": "suscipit", "staff_id": "nostrum", "note": "rtonzhbhmajoeah" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets/mark/autem/repairs" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"office_id\": \"suscipit\",
    \"staff_id\": \"nostrum\",
    \"note\": \"rtonzhbhmajoeah\"
}"

Mark An Asset As Donated

POST

https://assetapi.insuretech.com.ng

/api/v1/assets/mark/{asset_slug}/donated

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

iste

Body Parameters

recipient_name

string

required

Example:

nihil

recipient_phone

string

required

Example:

recipient_address

string

required

Example:

reason

string

Example:

reprehenderit

Auth

Bearer

Headers

URL Parameters

Body

{ "recipient_name": "nihil", "recipient_phone": "in", "recipient_address": "id", "reason": "reprehenderit" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets/mark/iste/donated" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"recipient_name\": \"nihil\",
    \"recipient_phone\": \"in\",
    \"recipient_address\": \"id\",
    \"reason\": \"reprehenderit\"
}"

Mark An Asset As Sold

POST

https://assetapi.insuretech.com.ng

/api/v1/assets/mark/{asset_slug}/sold

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

pariatur

Body Parameters

buyer_name

string

required

Example:

distinctio

buyer_phone

string

required

Example:

molestiae

attachment

file

required

The image.

Example:

C:\Users\ranke\AppData\Local\Temp\php7BB2.tmp

sale_price

number

required

Must be at least 0.

Example:

sale_profit

number

required

Must be at least 0.

Example:

sale_loss

number

required

Must be at least 0.

Example:

note

string

Example:

aspernatur

sale_date

string

required

Must be a valid date.

Example:

2025-04-24T17:27:17

payment_method

string

required

Must be one of:

cash
bank transfer
cheque

Example:

bank transfer

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/assets/mark/pariatur/sold" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "buyer_name=distinctio"\
    --form "buyer_phone=molestiae"\
    --form "sale_price=27"\
    --form "sale_profit=64"\
    --form "sale_loss=28"\
    --form "note=aspernatur"\
    --form "sale_date=2025-04-24T17:27:17"\
    --form "payment_method=bank transfer"\
    --form "attachment=@C:\Users\ranke\AppData\Local\Temp\php7BB2.tmp"

Mark An Asset As Stolen

PATCH

https://assetapi.insuretech.com.ng

/api/v1/assets/mark/{asset_slug}/stolen

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

qui

Body Parameters

note

required

A note on the stolen asset.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "note": "et" }

Received response

Example request:

curl --request PATCH \
    "https://assetapi.insuretech.com.ng/api/v1/assets/mark/qui/stolen" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"note\": \"et\"
}"

View History

GET

https://assetapi.insuretech.com.ng

/api/v1/assets/history/{asset_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

labore

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/assets/history/labore" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

View Single History Detail

GET

https://assetapi.insuretech.com.ng

/api/v1/assets/view-history/{history_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

history_id

integer

required

The ID of the history.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/assets/view-history/3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get Depreciation Schedule

GET

https://assetapi.insuretech.com.ng

/api/v1/assets/{asset_slug}/depreciation-schedule

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

repellendus

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/assets/repellendus/depreciation-schedule" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Adjust Asset Cost Amount

PATCH

https://assetapi.insuretech.com.ng

/api/v1/assets/{asset_slug}/adjust-cost

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

asset_slug

string

required

The slug of the asset.

Example:

totam

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://assetapi.insuretech.com.ng/api/v1/assets/totam/adjust-cost" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Authentication

POST

https://assetapi.insuretech.com.ng

/api/v1/login

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

staff_id

string

required

The Staff ID of The User.

Example:

SLO/1900

password

string

required

The Password of The User.

Example:

~vQ{2!;)`*;.;V

Headers

Body

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff_id\": \"SLO\\/1900\",
    \"password\": \"~vQ{2!;)`*;.;V\"
}"

Signout User

POST

https://assetapi.insuretech.com.ng

/api/v1/logout

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/logout" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Change Password

POST

https://assetapi.insuretech.com.ng

/api/v1/reset-password

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

old_password

string

required

The user's old password.

Example:

vel

new_password

string

required

The user's new password.

Example:

sint

Auth

Bearer

Headers

Body

{ "old_password": "vel", "new_password": "sint" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/reset-password" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"old_password\": \"vel\",
    \"new_password\": \"sint\"
}"

Custom Forms

Get List Of Custom Forms

GET

https://assetapi.insuretech.com.ng

/api/v1/custom-forms

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Filter By Module The Form Applies To.

Example:

Asset

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/custom-forms?query=Asset" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create A New Custom Form.

POST

https://assetapi.insuretech.com.ng

/api/v1/custom-forms

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

required

The name of the custom form.

Example:

eligendi

applies_to

required

The module the form applies.

Example:

sit

required

Well According to the UI/UX guy this is used to denote the section heading the form shows for a module

Example:

eaque

fields

object[]

required

These are the fields the form contains along with their data type and required .

Auth

Bearer

Headers

Body

{ "name": "eligendi", "applies_to": "sit", "on": "eaque", "fields": [ { "name": "name", "type": "int", "required": true } ] }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/custom-forms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"eligendi\",
    \"applies_to\": \"sit\",
    \"on\": \"eaque\",
    \"fields\": [
        {
            \"name\": \"name\",
            \"type\": \"int\",
            \"required\": true
        }
    ]
}"

Get Details For A Custom Form

GET

https://assetapi.insuretech.com.ng

/api/v1/custom-forms/{form_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

form_id

string

required

The ID of the form.

Example:

nesciunt

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/custom-forms/nesciunt" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update A Custom Form's Details.

PUT

https://assetapi.insuretech.com.ng

/api/v1/custom-forms/{form_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

form_id

string

required

The ID of the form.

Example:

iusto

Body Parameters

name

required

The name of the custom form.

Example:

consequuntur

applies_to

required

The module the form applies.

Example:

illo

required

Well According to the UI/UX guy this is used to denote the section heading the form shows for a module

Example:

labore

fields

object[]

required

These are the fields the form contains along with their data type and required .

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "consequuntur", "applies_to": "illo", "on": "labore", "fields": [ { "name": "name", "type": "int", "required": true } ] }

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/custom-forms/iusto" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"consequuntur\",
    \"applies_to\": \"illo\",
    \"on\": \"labore\",
    \"fields\": [
        {
            \"name\": \"name\",
            \"type\": \"int\",
            \"required\": true
        }
    ]
}"

Remove A Custom Form.

DELETE

https://assetapi.insuretech.com.ng

/api/v1/custom-forms/{form_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

form_id

string

required

The ID of the form.

Example:

velit

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://assetapi.insuretech.com.ng/api/v1/custom-forms/velit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Endpoints

View Dashboard Analytics

GET

https://assetapi.insuretech.com.ng

/api/v1/dashboard

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

period

string

The period to filter the statistics.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/dashboard?period=12" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Health

Health Check Endpoint

GET

https://assetapi.insuretech.com.ng

/api/health

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/health" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    x-ratelimit-limit
                                                            : 60
                                                                                                                    x-ratelimit-remaining
                                                            : 59
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "status": "OK",
    "services": {
        "database": "up"
    }
}

Migrations

Upload New Migration Sheet

POST

https://assetapi.insuretech.com.ng

/api/v1/settings/migrations

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

files

string[]

required

The migration files.

Headers

Body

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/settings/migrations" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"files\": [
        \"non\"
    ]
}"

Example response:

{
"message": "Migration file uploaded successfully.",
"files": {
   "path": "path-to-file",
   "name": "example file",
   "extension": "xlsx",
   "size": "3MB"
 },
 "total_files": 3,
 "total_size": "357982MB"
 "success": true
}

Notification Settings

Toggle Repair Due Date Notification

PATCH

https://assetapi.insuretech.com.ng

/api/v1/settings/notifications/toggle/repair-due-date

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request PATCH \
    "https://assetapi.insuretech.com.ng/api/v1/settings/notifications/toggle/repair-due-date" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Toggle Asset Depreciated Notification

PATCH

https://assetapi.insuretech.com.ng

/api/v1/settings/notifications/toggle/depreciated-asset-notify

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request PATCH \
    "https://assetapi.insuretech.com.ng/api/v1/settings/notifications/toggle/depreciated-asset-notify" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Notifications

Get All Notifications

GET

https://assetapi.insuretech.com.ng

/api/v1/notifications

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

optional The search query.

Example:

'user'

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/notifications?query=%27user%27" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

View A Notification

GET

https://assetapi.insuretech.com.ng

/api/v1/notifications/{notification_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

notification_id

string

required

The ID of the notification.

Example:

dignissimos

notification

string

required

The ID of the notification.

Example:

occaecati

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/notifications/dignissimos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Delete A Single Notification

DELETE

https://assetapi.insuretech.com.ng

/api/v1/notifications/{notification_id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

notification_id

string

required

The ID of the notification.

Example:

quidem

notification

string

required

The ID of the notification.

Example:

error

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://assetapi.insuretech.com.ng/api/v1/notifications/quidem" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete All Notifications

DELETE

https://assetapi.insuretech.com.ng

/api/v1/notifications

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "https://assetapi.insuretech.com.ng/api/v1/notifications" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mark A Notification As Read

PUT

https://assetapi.insuretech.com.ng

/api/v1/notifications/mark/{notification_id}/read

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

notification_id

string

required

The ID of the notification.

Example:

tempore

notification

string

required

The ID of the notification.

Example:

ipsa

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/notifications/mark/tempore/read" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mark All Notifications As Read

PUT

https://assetapi.insuretech.com.ng

/api/v1/notifications/mark-all-as-read

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/notifications/mark-all-as-read" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Offices

List All Offices.

GET

https://assetapi.insuretech.com.ng

/api/v1/offices

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Search An Office.

Example:

Head Office

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/offices?query=Head+Office" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create a New Office.

POST

https://assetapi.insuretech.com.ng

/api/v1/offices

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

required

The name of the office.

Example:

pick a name

description

required

The description of the office.

Example:

describe the office

location

required

The location where the office is situated.

Example:

pick a location

parent_office_id

string

required

Example:

harum

Auth

Bearer

Headers

Body

{ "name": "pick a name", "description": "describe the office", "location": "pick a location", "parent_office_id": "harum" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/offices" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"pick a name\",
    \"description\": \"describe the office\",
    \"location\": \"pick a location\",
    \"parent_office_id\": \"harum\"
}"

Get A Specific Office's Details.

GET

https://assetapi.insuretech.com.ng

/api/v1/offices/{office_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

office_slug

integer

required

The slug of the office.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/offices/13" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update An Office's Details

PUT

https://assetapi.insuretech.com.ng

/api/v1/offices/{office_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

office_slug

integer

required

The slug of the office.

Example:

Body Parameters

name

required

The name of the office.

Example:

pick a name

description

required

The description of the office.

Example:

describe the office

location

required

The location where the office is situated.

Example:

pick a location

parent_office_id

string

required

Example:

temporibus

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "pick a name", "description": "describe the office", "location": "pick a location", "parent_office_id": "temporibus" }

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/offices/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"pick a name\",
    \"description\": \"describe the office\",
    \"location\": \"pick a location\",
    \"parent_office_id\": \"temporibus\"
}"

Get Staff in this Office

GET

https://assetapi.insuretech.com.ng

/api/v1/offices/{office_slug}/staff

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

office_slug

integer

required

The slug of the office.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/offices/10/staff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Reports

Get A Summary of Asset Inventory Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/inventory

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

cumque

sort_by

string

Sort the results by the given field.

Example:

nihil

sort_order

string

Sort the results by the given order.

Example:

sit

current_office_id

integer

Filter results by a given Office.

Example:

category_id

integer

Filter results by a given Category.

Example:

status

string

Filter results by a given Status.

Example:

date_from

string

Filter results by a given Start Date.

Example:

deleniti

date_to

string

Filter results by a given End Date.

Example:

labore

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/inventory?query=cumque&sort_by=nihil&sort_order=sit&current_office_id=8&category_id=5&status=et&date_from=deleniti&date_to=labore" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get A Summary of Asset Depreciation Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/depreciation

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

ullam

sort_by

string

Sort the results by the given field.

Example:

sapiente

sort_order

string

Sort the results by the given order.

Example:

office_id

integer

Filter results by a given Office.

Example:

category_id

integer

Filter results by a given Category.

Example:

depreciated_status

boolean

string Filter results by a Depreciation Status.

Example:

date_from

string

Filter results by a given Start Date.

Example:

voluptatem

date_to

string

Filter results by a given End Date.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/depreciation?query=ullam&sort_by=sapiente&sort_order=at&office_id=17&category_id=17&depreciated_status=1&date_from=voluptatem&date_to=id" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get A Summary of Asset Purchase Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/purchases

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

odio

sort_by

string

Sort the results by the given field.

Example:

accusantium

sort_order

string

Sort the results by the given order.

Example:

voluptate

office_id

integer

Filter results by a given Purchase Office.

Example:

category_id

integer

Filter results by a given Category.

Example:

vendor

string

Filter results by a given Vendor.

Example:

nihil

date_from

string

Filter results by a given Start Date.

Example:

nostrum

date_to

string

Filter results by a given End Date.

Example:

libero

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/purchases?query=odio&sort_by=accusantium&sort_order=voluptate&office_id=20&category_id=11&vendor=nihil&date_from=nostrum&date_to=libero" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get A Summary of Asset Location Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/location

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

nemo

sort_by

string

Sort the results by the given field.

Example:

sort_order

string

Sort the results by the given order.

Example:

aspernatur

purchase_office_id

integer

Filter results by a given Purchase Office.

Example:

office_id

integer

Filter results by a given Office.

Example:

category_id

integer

Filter results by a given Category.

Example:

date_from

string

Filter results by a given Start Date.

Example:

voluptate

date_to

string

Filter results by a given End Date.

Example:

eum

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/location?query=nemo&sort_by=et&sort_order=aspernatur&purchase_office_id=1&office_id=9&category_id=13&date_from=voluptate&date_to=eum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get A Summary of Asset Sales Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/sales

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

laborum

sort_by

string

Sort the results by the given field.

Example:

sapiente

sort_order

string

Sort the results by the given order.

Example:

soluta

purchase_office_id

integer

Filter results by a given Purchase Office.

Example:

office_id

integer

Filter results by a given Office.

Example:

category_id

integer

Filter results by a given Category.

Example:

date_from

string

Filter results by a given Start Date.

Example:

voluptatem

date_to

string

Filter results by a given End Date.

Example:

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/sales?query=laborum&sort_by=sapiente&sort_order=soluta&purchase_office_id=5&office_id=20&category_id=13&date_from=voluptatem&date_to=ut" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get A Summary of Asset Warranty Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/warranty

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

sort_by

string

Sort the results by the given field.

Example:

maxime

sort_order

string

Sort the results by the given order.

Example:

velit

office_id

integer

Filter results by a given Office.

Example:

category_id

integer

Filter results by a given Category.

Example:

warranty_status

string

Filter results by Warranty Status.

Example:

quia

date_from

string

Filter results by a given Start Date.

Example:

harum

date_to

string

Filter results by a given End Date.

Example:

rerum

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/warranty?query=et&sort_by=maxime&sort_order=velit&office_id=8&category_id=4&warranty_status=quia&date_from=harum&date_to=rerum" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get A Summary of Audit Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/audit

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

sort_by

string

Sort the results by the given field.

Example:

dolorum

sort_order

string

Sort the results by the given order.

Example:

quae

user_id

integer

Filter results by a given Purchase Office.

Example:

office_id

integer

Filter results by a given Office.

Example:

entity

string

Filter results by a given Entity Type.

Example:

staff

date_from

string

Filter results by a given Start Date.

Example:

aut

date_to

string

Filter results by a given End Date.

Example:

unde

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/audit?query=ea&sort_by=dolorum&sort_order=quae&user_id=19&office_id=2&entity=staff&date_from=aut&date_to=unde" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get A Summary of Financial Reports

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/financial

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

a search term.

Example:

perferendis

sort_by

string

Sort the results by the given field.

Example:

sort_order

string

Sort the results by the given order.

Example:

dolor

category_id

integer

Filter results by a given Purchase Office.

Example:

office_id

integer

Filter results by a given Office.

Example:

date_from

string

Filter results by a given Start Date.

Example:

non

date_to

string

Filter results by a given End Date.

Example:

qui

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/financial?query=perferendis&sort_by=et&sort_order=dolor&category_id=16&office_id=7&date_from=non&date_to=qui" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get Summary Report

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/summary

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

year

string

Get Results For An Interval.

Example:

dignissimos

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/summary?year=dignissimos" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get All The Year Ranges

GET

https://assetapi.insuretech.com.ng

/api/v1/reports/year-range

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/reports/year-range" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Roles And Permissions

Get Roles In The System

GET

https://assetapi.insuretech.com.ng

/api/v1/guards

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/guards" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Add New Role

POST

https://assetapi.insuretech.com.ng

/api/v1/guards

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Example:

autem

description

string

required

Must not be greater than 1000 characters.

Example:

Quisquam libero soluta quis libero perferendis eligendi aspernatur.

Auth

Bearer

Headers

Body

{ "name": "autem", "description": "Quisquam libero soluta quis libero perferendis eligendi aspernatur." }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/guards" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"autem\",
    \"description\": \"Quisquam libero soluta quis libero perferendis eligendi aspernatur.\"
}"

Create A New Permission For A Module

POST

https://assetapi.insuretech.com.ng

/api/v1/guards/permissions

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

module_slug

string

required

Example:

nisi

permissions

object

required

Must have at least 1 items.

Example:

[]

Auth

Bearer

Headers

Body

{ "module_slug": "nisi", "permissions": [] }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/guards/permissions" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"module_slug\": \"nisi\",
    \"permissions\": []
}"

Get Modules in the system

GET

https://assetapi.insuretech.com.ng

/api/v1/guards/list-modules

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/guards/list-modules" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Get Role Information

GET

https://assetapi.insuretech.com.ng

/api/v1/guards/{role_slug}/view

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

role_slug

string

required

The slug of the role.

Example:

corrupti

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/guards/corrupti/view" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update Role Information

PUT

https://assetapi.insuretech.com.ng

/api/v1/guards/{role_slug}/edit

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

role_slug

string

required

The slug of the role.

Example:

dolor

Body Parameters

name

string

required

Example:

description

string

required

Must not be greater than 1000 characters.

Example:

Laudantium omnis ea velit ab.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "et", "description": "Laudantium omnis ea velit ab." }

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/guards/dolor/edit" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"et\",
    \"description\": \"Laudantium omnis ea velit ab.\"
}"

Delete Role

DELETE

https://assetapi.insuretech.com.ng

/api/v1/guards/{role_slug}/delete

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

role_slug

string

required

The slug of the role.

Example:

quas

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://assetapi.insuretech.com.ng/api/v1/guards/quas/delete" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Toggle Role Status

PATCH

https://assetapi.insuretech.com.ng

/api/v1/guards/{role_slug}/toggle

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

role_slug

string

required

The slug of the role.

Example:

adipisci

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://assetapi.insuretech.com.ng/api/v1/guards/adipisci/toggle" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get Permissions For Role In A Module

GET

https://assetapi.insuretech.com.ng

/api/v1/guards/{role_slug}/permissions/{module_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

role_slug

string

required

The slug of the role.

Example:

blanditiis

module_slug

string

required

The slug of the module.

Example:

odio

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/guards/blanditiis/permissions/odio" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Assign Permissions To A Role For A Module

POST

https://assetapi.insuretech.com.ng

/api/v1/guards/{role_slug}/permissions/{module_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

role_slug

string

required

The slug of the role.

Example:

quaerat

module_slug

string

required

The slug of the module.

Example:

non

Body Parameters

permissions

string[]

required

Example:

["corporis"]

Auth

Bearer

Headers

URL Parameters

Body

{ "permissions": [ "corporis" ] }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/guards/quaerat/permissions/non" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"permissions\": [
        \"corporis\"
    ]
}"

Settings

Get Global Depreciation Settings

GET

https://assetapi.insuretech.com.ng

/api/v1/settings/depreciation-settings

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/settings/depreciation-settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update Global Depreciation Settings

PATCH

https://assetapi.insuretech.com.ng

/api/v1/settings/depreciation-settings

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

accumulation

string

required

Must be one of:

daily
weekly
fortnightly
monthly
quarterly
semi-annually
yearly

Example:

daily

posting

string

required

Must be one of:

daily
weekly
fortnightly
monthly
quarterly
semi-annually
yearly

Example:

monthly

Auth

Bearer

Headers

Body

{ "accumulation": "daily", "posting": "monthly" }

Received response

Example request:

curl --request PATCH \
    "https://assetapi.insuretech.com.ng/api/v1/settings/depreciation-settings" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"accumulation\": \"daily\",
    \"posting\": \"monthly\"
}"

Staff

Get A List of Staff.

GET

https://assetapi.insuretech.com.ng

/api/v1/staff

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Search A Staff.

Example:

Staff

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/staff?query=Staff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Add a New Staff.

POST

https://assetapi.insuretech.com.ng

/api/v1/staff

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

staff_id

required

The Staff ID Allocated to This Staff.

Example:

autem

office_id

required

The Office ID This Staff Belongs To.

Example:

vel

firstname

required

The Firstname of The Staff.

Example:

illo

lastname

required

The Lastname of The Staff.

Example:

quisquam

string

Must be a valid email address.

Example:

jeanie.lind@example.net

designation

required

The Role in the office.

Example:

architecto

Auth

Bearer

Headers

Body

{ "staff_id": "autem", "office_id": "vel", "firstname": "illo", "lastname": "quisquam", "email": "jeanie.lind@example.net", "designation": "architecto" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/staff" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff_id\": \"autem\",
    \"office_id\": \"vel\",
    \"firstname\": \"illo\",
    \"lastname\": \"quisquam\",
    \"email\": \"jeanie.lind@example.net\",
    \"designation\": \"architecto\"
}"

Get A Single Staff's Details.

GET

https://assetapi.insuretech.com.ng

/api/v1/staff/{staff_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

staff_slug

integer

required

The slug of the staff.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/staff/18" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update A Staff's Details.

PUT

https://assetapi.insuretech.com.ng

/api/v1/staff/{staff_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

staff_slug

integer

required

The slug of the staff.

Example:

Body Parameters

staff_id

required

The Staff ID Allocated to This Staff.

Example:

illum

office_id

required

The Office ID This Staff Belongs To.

Example:

odio

firstname

required

The Firstname of The Staff.

Example:

beatae

lastname

required

The Lastname of The Staff.

Example:

string

Must be a valid email address.

Example:

lflatley@example.net

designation

required

The Role in the office.

Example:

quasi

Auth

Bearer

Headers

URL Parameters

Body

{ "staff_id": "illum", "office_id": "odio", "firstname": "beatae", "lastname": "ut", "email": "lflatley@example.net", "designation": "quasi" }

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/staff/16" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff_id\": \"illum\",
    \"office_id\": \"odio\",
    \"firstname\": \"beatae\",
    \"lastname\": \"ut\",
    \"email\": \"lflatley@example.net\",
    \"designation\": \"quasi\"
}"

Remove A Staff.

DELETE

https://assetapi.insuretech.com.ng

/api/v1/staff/{staff_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

staff_slug

integer

required

The slug of the staff.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://assetapi.insuretech.com.ng/api/v1/staff/14" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get A listing of Assets Used By A Staff.

GET

https://assetapi.insuretech.com.ng

/api/v1/staff/{staff_slug}/assets

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

staff_slug

integer

required

The slug of the staff.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/staff/20/assets" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Users

Return List Of Users.

GET

https://assetapi.insuretech.com.ng

/api/v1/users

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Search A User.

Example:

Dev

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/users?query=Dev" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Create New user

POST

https://assetapi.insuretech.com.ng

/api/v1/users

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

staff_id

required

The Staff ID For The User

Example:

firstname

required

The User's Firstname.

Example:

numquam

lastname

required

The User's Lastname.

Example:

repellendus

required

The User's Email.

Example:

kmcclure@example.org

password

required

The User's Password.

Example:

hDDQypi-,]#Ubq(I

office_id

required

The Office ID of this User

Example:

corrupti

role

required

The Role Permissions For The User.

Example:

user

Auth

Bearer

Headers

Body

{ "staff_id": "a", "firstname": "numquam", "lastname": "repellendus", "email": "kmcclure@example.org", "password": "hDDQypi-,]#Ubq(I", "office_id": "corrupti", "role": "user" }

Received response

Example request:

curl --request POST \
    "https://assetapi.insuretech.com.ng/api/v1/users" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff_id\": \"a\",
    \"firstname\": \"numquam\",
    \"lastname\": \"repellendus\",
    \"email\": \"kmcclure@example.org\",
    \"password\": \"hDDQypi-,]#Ubq(I\",
    \"office_id\": \"corrupti\",
    \"role\": \"user\"
}"

Get A Single User's Details

GET

https://assetapi.insuretech.com.ng

/api/v1/users/{user_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_slug

string

required

The slug of the user.

Example:

9ec0f37a-a2f0-4e6d-83b4-09132288ff2f

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/users/9ec0f37a-a2f0-4e6d-83b4-09132288ff2f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

Update A User's Data

PUT

https://assetapi.insuretech.com.ng

/api/v1/users/{user_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_slug

string

required

The slug of the user.

Example:

9ec0f37a-a2f0-4e6d-83b4-09132288ff2f

Body Parameters

staff_id

required

The Staff ID For The User.

Example:

labore

firstname

required

The User's Firstname.

Example:

vitae

lastname

required

The User's Lastname.

Example:

sit

string

Must be a valid email address.

Example:

qroberts@example.net

password

required

The User's Password.

Example:

!:|s/l

office_id

required

The Office ID of this User

Example:

laborum

role

required

The Role Permissions For The User.

Example:

user

Auth

Bearer

Headers

URL Parameters

Body

{ "staff_id": "labore", "firstname": "vitae", "lastname": "sit", "email": "qroberts@example.net", "password": "!:|s\/l", "office_id": "laborum", "role": "user" }

Received response

Example request:

curl --request PUT \
    "https://assetapi.insuretech.com.ng/api/v1/users/9ec0f37a-a2f0-4e6d-83b4-09132288ff2f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"staff_id\": \"labore\",
    \"firstname\": \"vitae\",
    \"lastname\": \"sit\",
    \"email\": \"qroberts@example.net\",
    \"password\": \"!:|s\\/l\",
    \"office_id\": \"laborum\",
    \"role\": \"user\"
}"

Update a User's Active Status

PATCH

https://assetapi.insuretech.com.ng

/api/v1/users/{user_slug}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user_slug

string

required

The slug of the user.

Example:

9ec0f37a-a2f0-4e6d-83b4-09132288ff2f

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://assetapi.insuretech.com.ng/api/v1/users/9ec0f37a-a2f0-4e6d-83b4-09132288ff2f" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Get Audit Logs.

GET

https://assetapi.insuretech.com.ng

/api/v1/activities

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Query Parameters

query

string

Search For Data.

Example:

head

Auth

Bearer

Headers

Query Parameters

Received response

Example request:

curl --request GET \
    --get "https://assetapi.insuretech.com.ng/api/v1/activities?query=head" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}