Check Customer Exclusion List

post

https://{your-totality-url}.com/api/customer-exclusion-checks

Check whether a customer is on the Customer Exclusion List (Settings > Blacklists > Customer Exclusion List) in real time, without pulling or scanning the full list. Matching mirrors the lead-rejection logic: SSN is the primary key, and First Name + Last Name + Date of Birth is the secondary fallback. Stronger identifier sets return a hard match (status "excluded"); weaker sets (First + Last + City + State, or First + Last only) return a soft "possible_match" for manual review and never a hard exclusion. Requires the OAuth client-credentials scope customerExclusionList.check ("Check Customer Exclusion List").

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Provide at least one identifier: a valid SSN, First Name + Last Name, email, or phone. Additional fields (Date of Birth, City, State) enable stronger match combinations. Which combinations return a hard exclusion vs a soft possible match is configured per lender under Settings > Blacklists.

ssn

string

^(\d{9}|\d{3}-\d{2}-\d{4})$

The customer's Social Security Number, 9 digits with or without dashes. Primary matching key.

firstName

string

The customer's first name. Required together with lastName when no SSN is provided.

lastName

string

The customer's last name. Required together with firstName when no SSN is provided.

dateOfBirth

date

The customer's date of birth. Combined with first and last name, produces a hard exclusion match.

city

string

The customer's city. Combined with first name, last name, and state, produces a soft possible-match.

state

string

The customer's state. Combined with first name, last name, and city (or ZIP), produces a soft possible-match.

zip

string

The customer's ZIP / postal code. Combined with first name, last name, and state, produces a soft possible-match.

string

The customer's email address. Matched on its own as a single identifier.

phone

string

The customer's phone number (any format; matched on digits only). Matched on its own as a single identifier.

Responses

200Match result. Returned whether or not the customer is on the list - "not on the list" is a successful response, not an error.

400The minimum identifier requirement was not met - neither a valid SSN nor a complete First Name + Last Name was provided.

401Unauthenticated - the bearer token is missing, invalid, or expired.

403Forbidden - the token is valid but the client was not granted the customerExclusionList.check scope.

422Validation error - a malformed SSN (must be 9 digits, with or without dashes), an invalid dateOfBirth, a name/city/state field over 255 characters, or a malformed or empty JSON request body.

500Unexpected server error.