Artha API
  1. Customers
  • Introduction
  • Authentication
  • KYC/KYB Requirements
  • API Setup Guide
  • Customers
    • Create Customer
      POST
    • List Customers
      GET
    • Get Customer
      GET
    • Update Customer
      PATCH
  • Cards
    • Submit KYC/KYB Applicant
      POST
    • Issue Card
      POST
    • Cards List
      GET
    • Get Card
      GET
    • Get Sensitive Card Details
      GET
  • Card Operations
    • Activate Card
      POST
    • Freeze Card
      POST
    • Unfreeze Card
      POST
    • Cancel Card
      POST
    • Replace Card
      POST
    • Set / Reset Card PIN
      POST
    • Get Card Limits
      GET
    • Update Card Limits
      POST
  • Funding
    • Top Up Card
      POST
    • Get Card Balance
      GET
    • List Top-Up History
      GET
  • Transactions
    • List All Transactions
      GET
    • List Card Transactions
      GET
    • List Customer Transactions
      GET
    • Get Transaction
      GET
  • Products
    • List Products
    • Get Product
  • Utilities
    • Upload Documents
  • Webhook's
    • Webhooks
  1. Customers

Update Customer

PATCH
{{baseUrl}}/api/v1/Customers/{customerId}
Partially updates a customer's profile. Only fields included in the request body are updated — omitted fields remain unchanged.
Note: Email cannot be updated after creation. To update business details, include the business object.
Optional Fields
FieldTypeDescriptionConstraints
first_namestring- Example: JanetNullable
middle_namestring-Nullable
last_namestring-Nullable
emailstring (email)-Nullable
phone_codestring-Nullable
phone_numberstring-Nullable
countrystring-Min length: 2 · Max length: 2 · Nullable
statestring-Nullable
date_of_birthstring (date-time)-Nullable
genderstring-Nullable
addressAddressRequest--
businessBusinessDetails--
Optional Fields
FieldTypeDescriptionConstraints
first_namestring- Example: JanetNullable
middle_namestring-Nullable
last_namestring-Nullable
emailstring (email)-Nullable
phone_codestring-Nullable
phone_numberstring-Nullable
countrystring-Min length: 2 · Max length: 2 · Nullable
statestring-Nullable
date_of_birthstring (date-time)-Nullable
genderstring-Nullable
addressAddressRequest--
businessBusinessDetails--

📤 Response Fields#

FieldTypeDescriptionNotes
idstring (uuid)- Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6-
typestringindividual or business. Example: individual-
first_namestring- Example: Jane-
middle_namestring-nullable
last_namestring- Example: Doe-
emailstring- Example: jane.doe@example.com-
phone_codestring- Example: +44-
phone_numberstring- Example: 7700900000-
countrystring- Example: GB-
statestring-nullable
statusstringAccount status: active, suspended, closed. Example: active-
kyc_statestringKYC verification state: not_submitted, pending, approved, rejected. Example: approved-
date_of_birthstring (date-time)-nullable
genderstring-nullable
external_referencestring-nullable
businessobject-nullable
addressobject-nullable
created_atstring (date-time)--
updated_atstring (date-time)-nullable

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200
application/json
Customer updated successfully.
Body

🟠401
🟠404
Request Request Example
Shell
JavaScript
Java
Swift
curl --location -g --request PATCH '{{baseUrl}}/api/v1/Customers/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'X-API-Key;' \
--header 'X-Signature;' \
--header 'X-Timestamp;' \
--header 'X-Nonce;' \
--header 'X-Body-Hash;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "first_name": "Janet",
    "phone_number": "7700999888",
    "address": {
        "address_line_1": "10 Downing Street",
        "city": "London",
        "postal_code": "SW1A 2AA",
        "country": "GB"
    }
}'
Response Response Example
200 - Example 1
{}
Modified at 2026-02-18 13:17:15
Previous
Get Customer
Next
Submit KYC/KYB Applicant
Built with