⬆️Update Customer

A customers information may be updated if required.

Update Customer

PATCH {{baseUrl}}/customers/:customer_id

You may update Customer details attached to a specific customer_id using this endpoint. customer_id and api_token are the only fields you are not able to update as they are automatically generated and assigned when you use the POST Create New Customer endpoint. Updating the details of a Customer is pretty simple, but it is best explained with a before-and-after example.

Please note that updating customer fields may yield different results for any subsequent validations and verifications performed on the customer.

Path Parameters

Name	Type	Description
customer_id*	String	This is UUID for a specific customer that gets generated and returned in the POST Create New Customer response. It ensures that the Bank Account is created and can be looked up in future for that specific customer.

Request Body

Name	Type	Description
client_reference	String	This is a reference that you may use to identify and do a lookup on the Customer in your system. Each Customer needs to have a unique client_reference.
popi	String	This is used to store whether the Customer has given you Consent under the Protection Of Personal Information (POPI) Act to continue with collecting their data and performing additional verifications in Gathr.This is used to store whether the Customer has given you Consent under the Protection Of Personal Information (POPI) Act to continue with collecting their data and performing additional verifications in Gathr.
terms_and_conditions	String	This is used to store whether the Customer has agreed to the Terms and Conditions of the Application and Verifications you are performing.
email	String	The Customer's Email Address. It has to be of the format [e-mail]
id_number	String	This is the 13-digit South African ID Number of the Customer you are creating. Each Customer created with "id_type" = "id_number" will need to have a valid ID Number. You cannot create multiple Customers with the same ID Number on the same Gathr Tenant. When id_type "passport" is selected, there is no validation on the Passport Number.
first_name	String	The Customer's First Name as per their ID Document.
middle_name	String	The Customer's Last Name/Surname as per their ID Document.
last_name	String	The Customer's Last Name/Surname as per their ID Document.
id_type	String	This is the type of identification number you want to create the customer with. The options are: [Default] "id_number" OR "passport". You need to use "id_number" if you wish to get a Credit Report or perform an ID Verification on this customer.
country	String	The Customer's nationality .

Status Codes

200 - OK

Customer Updated

{
    "data": {
        "id": "16cd33d2-cf0a-66ad-8150-cb39e9b9ff27",
        "client_reference": "clientnumber1",
        "popi": null,
        "terms_and_conditions": null,
        "email": "[e-mail]",
        "id_number": "8511215433085",
        "first_name": "Chris",
        "middle_name": "Jovonovich",
        "last_name": "Wick",
        "full_name": "John Jovonovich Wick",
        "id_type": "id_number",
        "country": null,
        "initials": "CJW",
        "api_token": {{apiToken}}
    }
}

422 - Unprocessable Content

Invalid format - POPI Consent

{
    "errors": {
        "popi": [
            "The popi field must be true or false."
        ]
    }
}

Example

Before: Available Customer Information

{
    "data": {
        "id": "16cd33d2-cf0a-66ad-8150-cb39e9b9ff27",
        "client_reference": "clientnumber1",
        "popi": null,
        "terms_and_conditions": null,
        "email": "[e-mail]",
        "id_number": "8511215433085",
        "first_name": "John",
        "middle_name": "Jovonovich",
        "last_name": "Wick",
        "full_name": "John Jovonovich Wick",
        "id_type": "id_number",
        "country": null,
        "initials": "JJW",
        "api_token": {{apiToken}}
    }
}

Patch: Updating the customers first name and email address

{
    "email": "[e-mail]",
    "first_name": "Chris"
}

After: Updated Customer Information

{
    "data": {
        "id": "16cd33d2-cf0a-66ad-8150-cb39e9b9ff27",
        "client_reference": "clientnumber1",
        "popi": null,
        "terms_and_conditions": null,
        "email": "[e-mail]",
        "id_number": "8511215433085",
        "first_name": "Chris",
        "middle_name": "Jovonovich",
        "last_name": "Wick",
        "full_name": "John Jovonovich Wick",
        "id_type": "id_number",
        "country": null,
        "initials": "CJW",
        "api_token": {{apiToken}}
    }
}