Update Customer
The Update Customer API allows authorized users to update the information of an existing customer in the system.
API Method
PATCH
Endpoint
https://cebuana-apiuat.veryfyglobal.com/customers/{id}
Headers
Accept
application/json
Authorization
Bearer <YOUR_TOKEN>
Path Parameters
id
int
Yes
The unique identifier of the customer to update. Customer ID
Body Parameters
first_name
string
Yes
The first name of the customer. Essential for identifying the individual.
middle_name
string
Yes
The middle name of the customer. Important for complete identification.
last_name
string
Yes
The last name of the customer. Required for accurate full name representation.
email
string
Yes
The customer’s email address. Must be unique and valid, used for communication.
current_address
string
No
The current residential address of the customer. Optional for additional contact information.
permanent_address
string
No
The permanent address of the customer, if different from the current address.
place_of_birth
string
No
The birthplace of the customer. This is optional information for identity verification.
tin
string
No
Tax Identification Number (TIN). Should be unique for each customer and valid if provided.
sss
string
No
Social Security System (SSS) number, must be unique and valid.
document_type
integer
No
Type of identification document, represented by an integer value according to DocumentType enum.
id_no
string
No
Identification number associated with the document type.
id_photo
string
No
Base64 encoded image of the customer's identification document.
nationality
string
No
The nationality of the customer, represented as a string.
contact_number
string
No
The customer’s contact number for communication.
risk_assessments.*.type
integer
Yes
Type of risk assessment, must be an integer corresponding to the AssessmentType enum.
risk_assessments.*.value
string
Yes
The value associated with the risk assessment type.
risk_assessments.*.grade
integer
Yes
The grade of the risk assessment, must be an integer greater than or equal to 0.
Example Request
Request URL
PATCH /customers/1Request Body
{
"first_name": "John",
"middle_name": "A.",
"last_name": "Doe",
"email": "[email protected]",
"current_address": "123 Main St, Anytown, USA",
"permanent_address": "456 Elm St, Othertown, USA",
"place_of_birth": "Anytown, USA",
"tin": "123-456-789",
"sss": "987-654-321",
"document_type": 1,
"id_no": "ID123456",
"id_photo": "data:image/png;base64,...", // Base64 encoded image
"nationality": "American",
"contact_number": "+1234567890",
"risk_assessments": [
{
"type": 1,
"value": "Medium Risk",
"grade": 3
}
]
}Response Sample
{
"message": "Ok",
"data": []
}{
"code": "422.000.000",
"message": "The first name field is required. (and 3 more errors)",
"errors": {
"first_name": [
"The first name field is required."
],
"middle_name": [
"The middle name field is required."
],
"last_name": [
"The last name field is required."
],
"email": [
"The email field is required."
]
}
}{
"code": "403.000.000",
"message": "Invalid ability provided."
}Last updated