Get Customer

Endpoint to read a customer

Retrieve a customer

GET https://api.waldo.ai/customer?email=[e-mail]

Query Parameters

Name	Type	Description
<customer_field>	String	<customer_field> should be one or more of the following: customerId, email, officialId, zipCode, dob, externalId

Headers

Name	Type	Description
Authorization*	String	The token in the format Bearer eyJhbG...
Content-Type*	String	Expected type is application/json

Response

200: OK A list of customers found

{
    "customers": [
        {
            "createdAt": 1695892771782,
            "firstName": "Raych",
            "lastName": "Foss",
            "officialId": {
                "docType": "SSN",
                "value": "123-45-6789",
                "country": "US"
            },
            "dob": "1985-04-24",
            "address": "Trantor Blvd. 73",
            "email": "[e-mail]",
            "phone": "[phone]",
            "zipCode": "00001",
            "state": "IL",
            "externalId": "abcd-123-456-efgh",
            "customerId": "6515452382d40426aa45989a",
            "uri": "https://app.waldo.ai/customers/6515452382d40426aa45989a",
            "validation": {
                "status": "APPROVED",
                "kyc": "REJECTED",
                "fraudScore": 0.82,
                "fraudReport": false,
                "fraudCheck": false
            }
        }
    ]
}

403: Forbidden Missing authorization header

{
  "code": "NOT_AUTHORIZED",
  "message": "Not authorized."
}

401: Unauthorized Invalid token or expired

{
  "code": "INVALID_TOKEN",
  "message": "Invalid token."
}

403: Forbidden Service not authorized

{
  "code": "NOT_AUTHORIZED",
  "message": "You are not authorized to perform this action. Please contact support for assistance."
}

403: Forbidden Inactive API key

{
  "code": "API_KEY_REVOKED",
  "message": "This API key has been revoked. Please visit the Waldo AI dashboard to review your API key."
}