> For the complete documentation index, see [llms.txt](https://apidocs.juicefin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.juicefin.com/apis/card-status-and-management/search-cardholder.md).
# Search Cardholder
## Search Cardholder
The Search Cardholder API produces a list of cardholder matching the search criteria, including card details.
The FirstName and LastName parameters are converted based on the following rules: i. All \* characters are replaced with % ii. All ? characters are replaced with \_ iii. All characters that are NOT a-zA-Z0-9\_% are removed
## Input Parameters:
| Name | Required | Definition | Comments |
| --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| CardNumber | C | Format: Numeric, 4 | relevant only if Indicator Type=CardPT or CardDOB or NameCard or CardDocID or CardDist |
| DateOfBirth | C | Format: yyyy-mm-dd
Description: Cardholder must be above 17 years old
| relevant only if Indicator Type=CardDOB or DocIdDOB or NameDOB |
| DistributorName | C | Format: Alphanumeric, 1-30 | relevant only if Indicator Type=NameDist or CardDocID or CardDist |
| DocId | C | Format: Alphanumeric, 4 | relevant only if Indicator Type=DocIdDOB |
| FirstName | C | Format: Alphanumeric and \* , 2-20 | relevant only if Indicator Type=NameDOB or NameCard or NameDist |
| IndicatorType | Y | Format:
DocIdDOB – allow to search cardholder by DocId & Date of Birth fields
NameDOB – allow to search cardholder by First Name or Last Name & Date of Birth fields
CardDOB – allow to search cardholder by CardNumber & Date of Birth fields
CardPT – allow to search cardholder by CardNumber & PT fields
NameCard - allow to search cardholder by First Name or Last Name & card (4 last) fields
NameDist - allow to search cardholder by First Name or Last Name & Dist fields
CardDocID - - allow to search cardholder by card (last 4) & DocID (last 4) fields
CardDist - allow to search cardholder by card (last 4) & Dist fields
Description: Provide indication on which of the multiple options to execute
| |
| LastName | C | Format: Alphanumeric and \* , 2-20 | relevant only if Indicator Type=NameDOB or NameCard or NameDist |
| PT | C | Format: Alphanumeric, 30 | relevant only if Indicator Type=CardPT |
## Output Parameters:
| Name | Definition | Failure Case | Success Case | Comments |
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ------------------------------------------------ |
| AddressLine1 | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| AddressLine2 | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CardBalance | Format: Numeric, 11 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CardExpirationDate | Format: MMDD | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CardNumber | Format: Numeric, 16 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CHState | Format options:
NRNV
RNV
V-PNS
V
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| City | Format: Alphanumeric, 20 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Country | Format: ISO Country code. Two characters.
Description: Based on ISO 3166-1 alpha-2 list.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| CurrentStatus | Format options:
CII
LOCKED\_CII
LOCK
ACT
SPND
LST
STLN
CC
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| DateOfBirth | Format: yyyy-mm-dd
Description: Cardholder must be above 17 years old
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| DocId | Format: Alphanumeric, 4 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| DocType | Format options:
SSN
PASS
UDL
MCN
INMATE
Description: Closed list of values.Type of government identification document used: SSN- Social Security Number, PASS - Passport number, 'UDL' – US Drivers license number,'MCN' - Matricula consular ,INMATE.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Email | Format: a-z (upper or lower), numbers, dash and underscore, 5-40
Description: Possible pattern:
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Fax | Format: Numeric, 6-10
Description: the fax number.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| FirstName | Format: Alphanumeric, 10 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| MiddleInitial | Format: Alpha,1
Description: Middle name char of the cardholder.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| LastName | Format: Alphanumeric, 15 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Phone | Format: Numeric, 6-15
Description: Phone number
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| PT | Format: Alphanumeric, 30 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| PTFriendlyName | Format: Alphanumeric, 1-120
Description: Product Type known name.
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| State | Format: Alphanumeric, 2 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| Status | Format:
ACTIVE (default)
ALL
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| StatusReasonCode | Format options:
CardExpired
CardReplaced
CIPException
CloseCardForDispute
Closed
ClosedByPM
Deceased
Excess-Chargeback
InsufficientKYC
InvalidArrowEyefiles
NegativeWriteOff
POBox
PrePurge
PurgedCard
PurgedFailedAtProcessor
ReadyToPrint
Arbitration
ByPM
CIPExceptionSus
Confirmed Fraud
Dispute
Lost
Lost-Stolen
Other
Poss Fraud
Poss Fraud Warm Address
Poss Fraud Warm Source IP
PrimaryCardSuspension
ProcSuspectedFraudWithNotes
ReDisputed
ReplaceFailure
ReplacementCardRequired
Represented
Stolen
StoreError
SuspectedFraud
TransactionCompletenessException
UnactivatedCard
UnactivatedReplacementCard
Violation
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| StatusReasonDesc | Format options:
Card Expired
Card Replaced
CIP Exception
Close Card Submited for Dispute
Closed
Closed By PM
Deceased
Excess-Chargeback
Insufficient KYC
Invalid Arrow Eye files
Negative Write-off
POBox
Pre Purge
Purged
Purged Failed At Processor
Ready To Print
Arbitration
By PM
CIP Exception
Confirmed Fraud
Dispute
Lost
Lost - Stolen
Other
Poss Fraud
Poss Fraud Warm Address
Poss Fraud Warm Source IP
Primary Card Suspension
Processor Suspected Fraud With Notes
Re-disputed
Replace Failure
Replacement Card Required
Represented
Stolen
Store error
Suspected Fraud
Suspected Fraud
Transaction Completeness Exception
Unactivated Card
Unactivated Replacement Card
Violation
| Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
| TotalRows | Format: Alphanumeric, 5 | Not returned | Returned | |
| Zip | Format: Numeric, 5 | Not returned | Returned | Returned as part of SearchResults/Cardholder tag |
## XML Samples
### Input XML
```json
;
920994
SearchCardholder
ExtAPI
NameDOB
1980-01-01
Dan
Kraut
```
```json
SearchCardholder
40433713200954111
0
StatusOK
NA
2009-11-19 13:54:16
40433713200954111
6
testSearch
a
cardholders
gdxfxvx
vcxvcx
vxvcx
CO
353544534
US
235432543253
1980-01-01 00:00:00.0
gfdgd@gffgfdg.fgd
100000000000
DL
ACT
NA
1020
Progreso Prepaid MasterCard (408) Flag - Sp
V-PNS
testSearch
a
cardholders
vvvpppeee
mnmnkd
nmnmdk
CO
353544534
US
235432543253
1980-01-01 00:00:00.0
gfdgd@gffgfdg.fgd
100000000000
DL
ACT
NA
1020
Progreso Prepaid MasterCard (408) Flag - Sp
V-PNS
```
```json
SearchCardholder
07071612200737105
70029
Data not found (cardholder not found)
Data not found (cardholder not found)
2021-10-01 12:37:50
07071612200737105
```