๐Ÿ”ŽFind a Single Customer

Lookup and retrieve Customer information for a Consumer using their customer_id.

Find Customer

GET {{baseUrl}}/customers/:customer_id

Path Parameters

NameTypeDescription

customer_id*

String

The UUID for a specific Customer that gets generated and returned in the POST Create New Customer response.

Status Codes

200 - OK

Customer Found

{
    "data": {
        "id": "16cd33d2-cf0a-66ad-8150-cb39e9b9ff27",
        "client_reference": "clientnumber1",
        "popi": 0,
        "terms_and_conditions": 0,
        "email": "john.w@finch-technologies.co.za",
        "id_number": "8511215433085",
        "first_name": "John",
        "middle_name": "Jovonovich",
        "last_name": "Wick",
        "full_name": "John Jovonovich Wick",
        "id_type": "id_number",
        "country": "South Africa",
        "initials": "JJW",
        "api_token": {{apiToken}}
    }
}
404 - Not Found

Customer Not Found

{
    "errors": {
        "code": "entity_not_found",
        "message": "Record not found in customers"
    }
}

Last updated