Sign in

v1

latestOpenAPI 3.0.02026-07-26280204.9 KB
Customer

Update Customer

Update one or more fields in a customer profile.

Note:

  1. To enable/disable a customer, send only the is_enabled parameter in UPDATE API. Sending any other parameters along with is_enabled in request body will result in Bad Request
  2. Use the Get Customer Fields API to retrieve the complete list of mandatory fields for creating a transactional customer and enabling fund transfers via a Customer Wallet or Virtual Account.
  3. Please ensure that all required mandatory documents are uploaded before updating a customer. You can refer to the Document Upload API. for more information.
patch/customer/{customer_id}

Path parameters

customer_idstring required
Example:customer_5d9390da9dd74ef28dc6f81d74eb3ff4

Customer Reference (customer_*)

Request body

descriptionstring

Description about Customer

typestring required

Type of Customer (company or individual)

organization_reference_idstring

Organization Reference Id

is_enabledboolean

Flag to enable/disable the customer

metadataobject

Custom Data

account_usage_purposestring required

Purpose of opening the account

Example request

{
  "description": "description",
  "is_enabled": true,
  "organization_reference_id": "",
  "account_usage_purpose": "",
  "metadata": {},
  "individual": {
    "first_name": "",
    "last_name": "",
    "dob": "",
    "email": "",
    "identification_type": "",
    "identification_custom_type": "",
    "identification_value": "",
    "country_of_residence": "",
    "nationality": "",
    "address_city": "",
    "address_country": "",
    "address_line1": "",
    "address_line2": "",
    "address_state": "",
    "address_zip_code": "",
    "phone_country_code": "",
    "phone_number": "",
    "identification_document_id": "",
    "address_proof_document_id": ""
  },
  "company": {
    "name": "",
    "registration_number": "",
    "incorporation_country": "",
    "address_line1": "",
    "address_line2": "",
    "address_state": "",
    "address_city": "",
    "address_zip_code": "",
    "address_country": "",
    "email": "",
    "phone_country_code": "",
    "phone_number": "",
    "address_proof_document_id": "",
    "incorporation_certificate_document_id": "",
    "incorporation_date": "",
    "authorized_user": {
      "first_name": "",
      "last_name": "",
      "dob": "",
      "email": "",
      "identification_type": "",
      "identification_custom_type": "",
      "identification_value": "",
      "country_of_residence": "",
      "nationality": "",
      "address_city": "",
      "address_country": "",
      "address_line1": "",
      "address_line2": "",
      "address_state": "",
      "address_zip_code": "",
      "phone_country_code": "",
      "phone_number": "",
      "identification_document_id": "",
      "address_proof_document_id": ""
    }
  }
}

Response

OK