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",
      "ipAddress": {
        "valid": true,
        "value": "12.34.56.78"
      },
      "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,
        "warningTags": {
          "ssn": {
            "label": "SSN Integrity",
            "passed": true
          },
          "date_of_birth": {
            "label": "Date of Birth Integrity",
            "passed": true
          },
          "address": {
            "label": "Address Integrity",
            "passed": true
          },
          "legal_and_regulatory_warnings": {
            "label": "Legal and Regulatory Warnings",
            "passed": false
          },
          "politically_exposed_person": {
            "label": "Politically Exposed Person",
            "passed": false
          },
          "sanction": {
            "label": "Sanctions List",
            "passed": true
          }
        },
        "kycBreakdown": {
          "identityBreakdown": {},
          "watchlistBreakdown": {
            "matches": [
              {
                "name": "Raych V. Foss",
                "entity": "United States Individuals Barred by FINRA",
                "entityUrl": "https://www.finra.org/rules-guidance/oversight-Oversight%20%26%20Enforcement/individuals-barred-finra",
                "type": "warning"
              },
              {
                "name": "Raych M. Foss",
                "entity": "United States Missouri House of Representatives",
                "entityUrl": "https://house.mo.gov/MemberRoster.aspx",
                "matchUrl": "https://house.mo.gov/MemberDetails.aspx?code=R&district=0&year=2024",
                "type": "pep"
              }
            ]
          }
        }
      }
    }
  ]
}

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."
}