Skip to main content
API docs by Redocly

eFica API (1.0.0)

Download OpenAPI specification:Download

eFica Team: melissa@efica.co.za

API documentation for eFica application

Authentication

Login

Authenticate user and return access token

Request Body schema: application/json
required
email
required
string <email>
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "user": {
    }
}

Register

Create a new user account

Request Body schema: application/json
required
email
required
string <email>
password
required
string
first_name
required
string
last_name
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "role": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Logout

Logout user and invalidate token

Authorizations:
bearerAuth

Responses

Refresh token

Get new access token using refresh token

Request Body schema: application/json
required
refresh_token
required
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string"
}

Response samples

Content type
application/json
{
  • "access_token": "string"
}

Billing

Get subscriptions

Retrieve user's subscription information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get invoices

Retrieve user's invoice history

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Individuals

Get individuals

Retrieve list of individuals

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create individual

Create a new individual record

Authorizations:
bearerAuth
Request Body schema: application/json
required
first_name
required
string
last_name
required
string
date_of_birth
string <date>
nationality
string
country_of_residence
string
employment_status
string
employment_industry
string
employment_type
string
annual_income
number
source_of_wealth
string
is_pep
boolean
pep_details
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "date_of_birth": "2019-08-24",
  • "nationality": "string",
  • "country_of_residence": "string",
  • "employment_status": "string",
  • "employment_industry": "string",
  • "employment_type": "string",
  • "annual_income": 0,
  • "source_of_wealth": "string",
  • "is_pep": true,
  • "pep_details": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "date_of_birth": "2019-08-24",
  • "nationality": "string",
  • "country_of_residence": "string",
  • "employment_status": "string",
  • "employment_industry": "string",
  • "employment_type": "string",
  • "annual_income": 0,
  • "source_of_wealth": "string",
  • "is_pep": true,
  • "pep_details": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get individual by ID

Retrieve a specific individual by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "date_of_birth": "2019-08-24",
  • "nationality": "string",
  • "country_of_residence": "string",
  • "employment_status": "string",
  • "employment_industry": "string",
  • "employment_type": "string",
  • "annual_income": 0,
  • "source_of_wealth": "string",
  • "is_pep": true,
  • "pep_details": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update individual

Update an existing individual record

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
first_name
string
last_name
string
date_of_birth
string <date>
nationality
string
country_of_residence
string
employment_status
string
employment_industry
string
employment_type
string
annual_income
number
source_of_wealth
string
is_pep
boolean
pep_details
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "date_of_birth": "2019-08-24",
  • "nationality": "string",
  • "country_of_residence": "string",
  • "employment_status": "string",
  • "employment_industry": "string",
  • "employment_type": "string",
  • "annual_income": 0,
  • "source_of_wealth": "string",
  • "is_pep": true,
  • "pep_details": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "date_of_birth": "2019-08-24",
  • "nationality": "string",
  • "country_of_residence": "string",
  • "employment_status": "string",
  • "employment_industry": "string",
  • "employment_type": "string",
  • "annual_income": 0,
  • "source_of_wealth": "string",
  • "is_pep": true,
  • "pep_details": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete individual

Delete an individual record

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Settings

Get countries

Retrieve list of available countries

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create country

Create a new country

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
code
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string"
}

Get country by ID

Retrieve a specific country by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string"
}

Update country

Update an existing country

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
code
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "code": "string"
}

Delete country

Delete a country

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get employment industries

Retrieve list of employment industries

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create employment industry

Create a new employment industry

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get employment industry by ID

Retrieve a specific employment industry by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update employment industry

Update an existing employment industry

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete employment industry

Delete an employment industry

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get employment types

Retrieve list of employment types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create employment type

Create a new employment type

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get employment type by ID

Retrieve a specific employment type by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update employment type

Update an existing employment type

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete employment type

Delete an employment type

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get individual document types

Retrieve list of individual document types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create individual document type

Create a new individual document type

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "required": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Get individual document type by ID

Retrieve a specific individual document type by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Update individual document type

Update an existing individual document type

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "required": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Delete individual document type

Delete an individual document type

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get entity industries

Retrieve list of entity industries

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create entity industry

Create a new entity industry

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get entity industry by ID

Retrieve a specific entity industry by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update entity industry

Update an existing entity industry

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete entity industry

Delete an entity industry

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get entity types

Retrieve list of entity types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create entity type

Create a new entity type

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get entity type by ID

Retrieve a specific entity type by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update entity type

Update an existing entity type

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete entity type

Delete an entity type

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get trust document types

Retrieve list of trust document types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create trust document type

Create a new trust document type

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "required": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Get trust document type by ID

Retrieve a specific trust document type by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Update trust document type

Update an existing trust document type

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "required": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Delete trust document type

Delete a trust document type

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get transaction types

Retrieve list of transaction types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create transaction type

Create a new transaction type

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get transaction type by ID

Retrieve a specific transaction type by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update transaction type

Update an existing transaction type

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete transaction type

Delete a transaction type

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get transaction frequencies

Retrieve list of transaction frequencies

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create transaction frequency

Create a new transaction frequency

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get transaction frequency by ID

Retrieve a specific transaction frequency by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update transaction frequency

Update an existing transaction frequency

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete transaction frequency

Delete a transaction frequency

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get transaction fundings

Retrieve list of transaction fundings

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create transaction funding

Create a new transaction funding

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get transaction funding by ID

Retrieve a specific transaction funding by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update transaction funding

Update an existing transaction funding

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete transaction funding

Delete a transaction funding

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get wealth sources

Retrieve list of wealth sources

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create wealth source

Create a new wealth source

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get wealth source by ID

Retrieve a specific wealth source by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update wealth source

Update an existing wealth source

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete wealth source

Delete a wealth source

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get public official types

Retrieve list of public official types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create public official type

Create a new public official type

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Get public official type by ID

Retrieve a specific public official type by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Update public official type

Update an existing public official type

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string"
}

Delete public official type

Delete a public official type

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Get entity document types

Retrieve list of entity document types

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create entity document type

Create a new entity document type

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "required": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Get entity document type by ID

Retrieve a specific entity document type by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Update entity document type

Update an existing entity document type

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
required
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "required": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "required": true
}

Delete entity document type

Delete an entity document type

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Users

Get users

Retrieve list of users

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create user

Create a new user

Authorizations:
bearerAuth
Request Body schema: application/json
required
email
required
string <email>
password
required
string
first_name
required
string
last_name
required
string
role
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "role": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get user by ID

Retrieve a specific user by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "role": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update user

Update an existing user

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
email
string <email>
first_name
string
last_name
string
role
string

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "role": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "role": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete user

Delete a user

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Trusts

Get trusts

Retrieve list of trusts

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create trust

Create a new trust

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
type
required
string
jurisdiction
string
settlor
string
trustee
string
beneficiary
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "settlor": "string",
  • "trustee": "string",
  • "beneficiary": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "settlor": "string",
  • "trustee": "string",
  • "beneficiary": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get trust by ID

Retrieve a specific trust by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "settlor": "string",
  • "trustee": "string",
  • "beneficiary": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update trust

Update an existing trust

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
type
string
jurisdiction
string
settlor
string
trustee
string
beneficiary
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "settlor": "string",
  • "trustee": "string",
  • "beneficiary": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "jurisdiction": "string",
  • "settlor": "string",
  • "trustee": "string",
  • "beneficiary": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete trust

Delete a trust

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Files

Get files

Retrieve list of files

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Upload file

Upload a new file

Authorizations:
bearerAuth
Request Body schema: multipart/form-data
required
file
required
string <binary>
type
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "filename": "string",
  • "original_name": "string",
  • "mime_type": "string",
  • "size": 0,
  • "url": "string",
  • "type": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Get file by ID

Retrieve a specific file by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "filename": "string",
  • "original_name": "string",
  • "mime_type": "string",
  • "size": 0,
  • "url": "string",
  • "type": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Delete file

Delete a file

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Entities

Get entities

Retrieve list of entities

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Create entity

Create a new entity

Authorizations:
bearerAuth
Request Body schema: application/json
required
name
required
string
type
required
string
industry
string
registration_number
string
country_of_incorporation
string
business_address
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "industry": "string",
  • "registration_number": "string",
  • "country_of_incorporation": "string",
  • "business_address": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "industry": "string",
  • "registration_number": "string",
  • "country_of_incorporation": "string",
  • "business_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Get entity by ID

Retrieve a specific entity by ID

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "industry": "string",
  • "registration_number": "string",
  • "country_of_incorporation": "string",
  • "business_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Update entity

Update an existing entity

Authorizations:
bearerAuth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string
type
string
industry
string
registration_number
string
country_of_incorporation
string
business_address
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "string",
  • "industry": "string",
  • "registration_number": "string",
  • "country_of_incorporation": "string",
  • "business_address": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "type": "string",
  • "industry": "string",
  • "registration_number": "string",
  • "country_of_incorporation": "string",
  • "business_address": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

Delete entity

Delete an entity

Authorizations:
bearerAuth
path Parameters
id
required
string

Responses

Dashboard

Get dashboard metrics

Retrieve dashboard metrics and statistics

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "total_individuals": 0,
  • "total_entities": 0,
  • "total_trusts": 0,
  • "pending_reviews": 0,
  • "completed_reviews": 0,
  • "risk_levels": {
    }
}

Contact

Send contact message

Send a contact message

Request Body schema: application/json
required
name
required
string
email
required
string <email>
message
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "email": "user@example.com",
  • "message": "string"
}

Health

Health check

Check API health status

Responses

Response samples

Content type
application/json
{
  • "status": "healthy",
  • "timestamp": "2019-08-24T14:15:22Z"
}

Ongoing Monitoring

Get ongoing monitoring

Retrieve ongoing monitoring data

Authorizations:
bearerAuth
query Parameters
page
integer
Default: 1
limit
integer
Default: 10

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}