👾Get Customer by Custom Property

Search for a Customer and retrieve their data using their client_reference, email or id_number.

Get Customer by Custom Property

GET {{baseUrl}}/customers/property/:property?value=

Path Parameters

Name	Type	Description
property*	String	This is the property you would like to search by (e.g. id_number, email, client_reference)

Properties you can use to search by:

ID Number

Search for a customers information by the South African ID number of the customer, as it appears on their ID document. You can retrieve the customer information in the GET Get Customer by Custom Property API call by making use of the id_number search parameter.

Client Reference

When creating a new Customer, the client_reference is a unique identifier created for a consumer. As a result you are able to retrieve the customer's information in the GET Get Customer by Custom Property API call by making use of the client_reference search parameter.

Email

You are able to retrieve the customer's information by making use of the search parameter email in the GET Get Customer by Custom Property API call.

Query Parameters

Name	Type	Description
value*	String	This is the value for the property: (e.g. "9001145117080", "[e-mail]", "clientnumber1")

Status Codes

200 - OK

Customer Found

{
    "data": {
        "id": "18cd33d2-cf0a-46ad-8150-cb39d9b9ff2f",
        "client_reference": "clientnumber1",
        "popi": 0,
        "terms_and_conditions": 0,
        "email": "[e-mail]",
        "id_number": "9001145117080",
        "first_name": "Chris",
        "middle_name": "James Patrick",
        "last_name": "Ball",
        "full_name": "Chris James Patrick Ball",
        "id_type": "id_number",
        "country": "South Africa",
        "initials": "C"
    }
}

404 - Not Found

Customer Not Found

{
    "errors": "Customer not found by id_number"
}

422 - Unprocessable Content

Invalid Search Parameter

{
    "errors": {
        "property": [
            "The selected property is invalid."
        ]
    }
}

Empty Value Search

{
    "errors": {
        "value": [
            "Value must be a valid string"
        ]
    }
}