Get All Customers

The Get All Customers API allows authorized users to retrieve a list of customers stored in the system.

API Method

GET

Endpoint

https://cebuana-apiuat.veryfyglobal.com/customers

Headers

Key	Value
Accept	application/json
Authorization	Bearer <YOUR_TOKEN>

Query Parameters

Parameter	Type	Required	Description
name	string	No	A string to filter customers by their full name (first name, middle name, last name).
firstName	string	No	Filter customers by their first name.
middleName	string	No	Filter customers by their middle name.
lastName	string	No	Filter customers by their last name.
email	string	No	Filter customers by their email address.
tin	string	No	Filter customers by their Tax Identification Number (TIN).
sss	string	No	Filter customers by their Social Security System (SSS) number.
documentType	string	No	Filter customers by their document type (e.g., passport, ID card).
idNo	string	No	Filter customers by their identification number.
assessmentRisk	string	No	Filter customers based on their risk assessment status.
search	string	No	A string to search customers by their name or ID number, utilizing a combined search on the full name and ID number fields.

Example Request

Request URL

GET /customers?name=John Doe&[email protected]

Response Sample

200: Ok

{
    "message": "Ok",
    "data": {
        "records": [
            {
                "id": 3,
                "first_name": "John",
                "middle_name": "Doe",
                "last_name": "1",
                "email": "[email protected]",
                "current_address": null,
                "permanent_address": null,
                "tin": null,
                "sss": null,
                "document_type": null,
                "id_no": "012345",
                "id_photo": null,
                "date_of_birth": "1969-12-31T16:00:00.000000Z",
                "place_of_birth": null,
                "nationality": null,
                "contact_number": null,
                "assessment_score": 0,
                "assessment_risk": {
                    "value": 0,
                    "description": "Low Risk"
                },
                "customer_risk_assessments": [
                    {
                        "id": 4,
                        "customer_id": 3,
                        "type": {
                            "value": 1,
                            "description": "Complete Name"
                        },
                        "value": "JOHN DOE 1",
                        "grade": 0
                    },
                    {
                        "id": 5,
                        "customer_id": 3,
                        "type": {
                            "value": 9,
                            "description": "Valid Government ID"
                        },
                        "value": "012345",
                        "grade": 0
                    },
                    {
                        "id": 38,
                        "customer_id": 3,
                        "type": {
                            "value": 0,
                            "description": "Profession"
                        },
                        "value": "EXECUTIVE EMPLOYEE",
                        "grade": 0
                    }
                ],
                "last_transaction_datetime": "2024-07-08 10:48:03"
            },
            {
                "id": 2,
                "first_name": "JOHN",
                "middle_name": "DOE",
                "last_name": "2",
                "email": "[email protected]",
                "current_address": null,
                "permanent_address": null,
                "tin": null,
                "sss": null,
                "document_type": null,
                "id_no": "12345",
                "id_photo": null,
                "date_of_birth": null,
                "place_of_birth": null,
                "nationality": null,
                "contact_number": null,
                "assessment_score": 0,
                "assessment_risk": {
                    "value": 0,
                    "description": "Low Risk"
                },
                "customer_risk_assessments": [
                    {
                        "id": 2,
                        "customer_id": 2,
                        "type": {
                            "value": 1,
                            "description": "Complete Name"
                        },
                        "value": "JOHN DOE 2",
                        "grade": 0
                    },
                    {
                        "id": 3,
                        "customer_id": 2,
                        "type": {
                            "value": 9,
                            "description": "Valid Government ID"
                        },
                        "value": "12345",
                        "grade": 0
                    }
                ],
                "last_transaction_datetime": "2024-05-06 11:23:20"
            },
            {
                "id": 1,
                "first_name": "JOHN",
                "middle_name": "DOE",
                "last_name": "3",
                "email": "[email protected]",
                "current_address": null,
                "permanent_address": null,
                "tin": null,
                "sss": null,
                "document_type": null,
                "id_no": null,
                "id_photo": null,
                "date_of_birth": "1969-12-24T16:00:00.000000Z",
                "place_of_birth": null,
                "nationality": null,
                "contact_number": null,
                "assessment_score": 0,
                "assessment_risk": {
                    "value": 0,
                    "description": "Low Risk"
                },
                "customer_risk_assessments": [
                    {
                        "id": 1,
                        "customer_id": 1,
                        "type": {
                            "value": 1,
                            "description": "Complete Name"
                        },
                        "value": "JOHN DOE 3",
                        "grade": 0
                    }
                ],
                "last_transaction_datetime": "2024-05-07 07:36:59"
            }
        ],
        "pagination": {
            "current_page": 1,
            "last_page": 1,
            "total_record": 3,
            "page_size": 20,
            "has_more_page": false
        }
    }
}

401: Unauthorized

403: Forbidden