🛡️ InsuApp CRUD API

REST API for Insurance Companies to Manage Customers & Policies

Version 1.0 | January 2026

🌐 Base URL & Information

Base URL: https://[Your subdomain]/crudapi

Content-Type: application/json
Authentication: Bearer Token (obtained via login)
Token Expiry: 24 hours
IP Whitelist: Your IP is whitelisted on login

🔐 Authentication Flow

Login: POST to /auth/login with your API key
Get Token: Response includes token and expiration date
Use Token: Add header Authorization: Bearer YOUR_TOKEN to all requests

Security: Your IP is whitelisted on login. Requests from other IPs will be rejected.

🔐 Authentication Endpoints

GET /auth 🔓 No Token Required Get auth info

Example Request

GET /auth

Response

{
    "status": "info",
    "message": "API Authentication",
    "endpoints": {
        "login": "POST /auth/login",
        "verify": "GET /auth/verify"
    }
}

POST /auth/login 🔓 No Token Required Login to get token

Request Body

Field	Type	Description
`api_key`	string required	Your API key

Example Request

POST /auth/login
Content-Type: application/json

{
    "api_key": "YOUR_API_KEY"
}

Response

{
    "status": "success",
    "data": {
        "token": "a1b2c3d4e5f6...",
        "expires_at": "2026-01-29 15:00:00",
        "expires_in": "24 hours",
        "ip_whitelisted": "192.168.1.100"
    }
}

GET /auth/verify Verify token

Headers

Example Request

GET /auth/verify
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": {
        "ip_whitelisted": "192.168.1.100",
        "expires_at": "2026-01-29 15:00:00",
        "hours_remaining": 23.5
    }
}

👥 Customers API

GET /customers List all customers

Headers

Query Parameters

Parameter	Description
`page`	Page number (default: 1)
`limit`	Records per page (default: 50)
`search`	Search in name, surname, email, mobile

Example Request

GET /customers?page=1&limit=10
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": [{
        "id": 7,
        "name": "John",
        "surname": "Smith",
        "mobile": "99123456"
    }],
    "pagination": {
        "page": 1,
        "total": 150
    }
}

GET /customers/{id} Get customer by ID

Headers

Example Request

GET /customers/7
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": {
        "id": 7,
        "name": "John",
        "surname": "Smith",
        "email": "[email protected]",
        "mobile": "99123456"
    }
}

GET /customers/{field}/{value} Search by field

Headers

Allowed Fields

unique_id, govID, email, mobile, name, surname, company

Example Request

GET /customers/mobile/99123456
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": [{
        "id": 7,
        "name": "John",
        "mobile": "99123456"
    }]
}

POST /customers/add Create new customer

Headers

Request Body

Field	Type	Description
`name`	string required	First name
`surname`	string required	Last name
`mobile`	string required	Mobile number
`govID`	string required	Government ID
`email`	string optional	Email
`telephone`	string optional	Telephone
`dob`	date optional	Date of birth (YYYY-MM-DD)
`company`	string optional	Company name

Example Request

POST /customers/add
Authorization: Bearer a1b2c3d4e5f6...
Content-Type: application/json

{
    "name": "John",
    "surname": "Smith",
    "mobile": "99123456",
    "govID": "823013",
    "email": "[email protected]"
}

Response

{
    "status": "success",
    "message": "Customer added successfully",
    "data": {
        "id": 8,
        "unique_id": "678abc"
    }
}

POST /customers/edit/{id} Update customer

Headers

Request Body

Field	Type	Description
`name`	string optional	First name
`surname`	string optional	Last name
`mobile`	string optional	Mobile
`govID`	string optional	Government ID
`email`	string optional	Email
`telephone`	string optional	Telephone
`dob`	date optional	Date of birth
`company`	string optional	Company

💡 Only include fields you want to update

Example Request

POST /customers/edit/7 Authorization: Bearer a1b2c3d4e5f6... Content-Type: application/json { "email": "[email protected]" }

Response

{
    "status": "success",
    "message": "Customer updated successfully",
    "rows_affected": 1
}

POST /customers/delete/{id} Delete customer

Headers

Request Body

No body required. ID in URL. Multiple IDs: /customers/delete/7,8,9

Example Request

POST /customers/delete/7
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "message": "Customer(s) deleted successfully",
    "rows_affected": 1
}

POST /customers/import Bulk import

Headers

Request Body

Field	Type	Description
`customers`	array required	Array of customer objects

Each requires: name, surname, mobile, govID

Example Request

POST /customers/import
Authorization: Bearer a1b2c3d4e5f6...
Content-Type: application/json

{
    "customers": [
        {"name":"John","surname":"Smith","mobile":"99111111","govID":"ID001"},
        {"name":"Jane","surname":"Doe","mobile":"99222222","govID":"ID002"}
    ]
}

Response

{
    "status": "success",
    "data": {"total":2,"success":2,"errors":0}
}

📋 Policies API

GET /policies List all policies

Headers

Query Parameters

Parameter	Description
`page`, `limit`	Pagination
`customer_id`	Filter by customer
`insurance_type`	Filter by type
`search`	Search in title

Example Request

GET /policies?customer_id=7
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": [{
        "id": 15,
        "title": "POL-2026-001",
        "type_name": "Life Insurance",
        "company_name": "ABC Insurance"
    }]
}

GET /policies/{id} Get policy by ID

Headers

Example Request

GET /policies/15
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": {
        "id": 15,
        "title": "POL-2026-001",
        "expire_date": "2026-12-31"
    }
}

GET /policies/customer/{id} Get policies by customer

Headers

Example Request

GET /policies/customer/7
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": [{"id":15,"title":"POL-2026-001"}],
    "count": 1
}

POST /policies/add Create new policy

Headers

Request Body

Field	Type	Description
`customer_id`	integer required	Customer ID
`title`	string required	Policy title
`insurance_type`	integer required	ID from /types endpoint (types table)
`insurance_company`	integer required	ID from /companies endpoint (insurance_companies table)
`expire_date`	date required	Expiry (YYYY-MM-DD)

Example Request

POST /policies/add
Authorization: Bearer a1b2c3d4e5f6...
Content-Type: application/json

{
    "customer_id": 7,
    "title": "POL-2026-002",
    "insurance_type": 1,
    "insurance_company": 5,
    "expire_date": "2027-06-30"
}

Response

{
    "status": "success",
    "message": "Policy added successfully",
    "data": {"id": 16}
}

POST /policies/edit/{id} Update policy

Headers

Request Body

Field	Type	Description
`customer_id`	integer optional	Customer ID
`title`	string optional	Policy title
`insurance_type`	integer optional	ID from /types endpoint (types table)
`insurance_company`	integer optional	ID from /companies endpoint (insurance_companies table)
`expire_date`	date optional	Expiry (YYYY-MM-DD)

💡 Only include fields you want to update

Example Request

POST /policies/edit/15
Authorization: Bearer a1b2c3d4e5f6...
Content-Type: application/json

{
    "expire_date": "2027-12-31"
}

Response

{
    "status": "success",
    "message": "Policy updated successfully"
}

POST /policies/delete/{id} Delete policy

Headers

Request Body

No body required. ID in URL. Multiple IDs: /policies/delete/15,16,17

Example Request

POST /policies/delete/15
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "message": "Policy(ies) deleted successfully"
}

POST /policies/import Bulk import

Headers

Request Body

Field	Type	Description
`policies`	array required	Array of policy objects

Each requires: customer_id, title, insurance_type, insurance_company, expire_date

Example Request

POST /policies/import
Authorization: Bearer a1b2c3d4e5f6...
Content-Type: application/json

{
    "policies": [
        {"customer_id":7,"title":"IMP-001","insurance_type":1,"insurance_company":5,"expire_date":"2027-12-31"}
    ]
}

Response

{
    "status": "success",
    "data": {"total":1,"success":1,"errors":0}
}

📚 Reference Data

GET /types List insurance types

Headers

Example Request

GET /types
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": [
        {"id":1,"name":"Life Insurance"},
        {"id":2,"name":"Health Insurance"}
    ]
}

💡 Use the id for insurance_type when creating policies

GET /companies List insurance companies

Headers

Example Request

GET /companies
Authorization: Bearer a1b2c3d4e5f6...

Response

{
    "status": "success",
    "data": [
        {"id":1,"name":"ABC Insurance","tel":"22111111"}
    ]
}

💡 Use the id for insurance_company when creating policies

⚠️ Error Codes

Code	HTTP	Description
`AUTH_HEADER_MISSING`	401	No Authorization header
`INVALID_AUTH_FORMAT`	401	Not "Bearer {token}" format
`TOKEN_NOT_FOUND`	401	Token doesn't exist
`TOKEN_EXPIRED`	401	Token expired (24h limit)
`IP_NOT_WHITELISTED`	401	IP doesn't match login IP