# Get Cardholder Data

## Get Cardholder Data

## <i class="fa-magic">:magic:</i>Input Parameters:

| Name   | Required | Definition                                                                                                                                                                                                        | Comments |
| ------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
| ID     | Y        | <p><strong>Format:</strong> Numeric, 1–19<br><strong>Description:</strong><br>Input should be RPID in case <code>IDType = RPID</code><br>Input should be Card Number in case <code>IDType = CardNumber</code></p> |          |
| IDType | Y        | <p><strong>Format options:</strong><br><code>CardNumber</code><br><code>RPID</code></p>                                                                                                                           |          |

## <i class="fa-laptop-code">:laptop-code:</i>Output Parameters:

| Name                                   | Definition                                                   | Failure Case | Success Case | Comments |
| -------------------------------------- | ------------------------------------------------------------ | ------------ | ------------ | -------- |
| FirstName                              | Format: Alphanumeric, 10                                     | Not returned | Returned     |          |
| MiddleInitial                          | <p>Format: Alpha,1<br>Middle name char of the cardholder</p> | Not returned | Returned     |          |
| LastName                               | Format: Alphanumeric, 15                                     | Not returned | Returned     |          |
| AddressLine1                           | Format: Alphanumeric, 30                                     | Not returned | Returned     |          |
| AddressLine2                           | Format: Alphanumeric, 30                                     | Not returned | Returned     |          |
| City                                   | Format: Alphanumeric, 20                                     | Not returned | Returned     |          |
| State                                  | Format: Alphanumeric, 2                                      | Not returned | Returned     |          |
| Zip                                    | Format: Numeric, 5                                           | Not returned | Returned     |          |
| Country                                | ISO Country code (2 chars)                                   | Not returned | Returned     |          |
| Phone                                  | Format: Numeric, 6-15                                        | Not returned | Returned     |          |
| Fax                                    | Format: Numeric, 6-10                                        | Not returned | Returned     |          |
| Email                                  | Format: 5-40 chars (email pattern)                           | Not returned | Returned     |          |
| IsReceiveSms                           | Enabled / Disabled / Blank / Mail                            | Not returned | Returned     |          |
| MobilePhone                            | Format: Numeric, 6-15                                        | Not returned | Returned     |          |
| IntPhoneNumber                         | International format (+ optional)                            | Not returned | Returned     |          |
| EarlyAccess                            | Format: Y/N                                                  | Not returned | Returned     |          |
| DateOfBirth                            | Format: yyyy-mm-dd                                           | Not returned | Returned     |          |
| VerificationRequest                    | UpdateAndVerify / UpdateOnly / NoUpdateOnVerificationError   | Not returned | Returned     |          |
| VerificationType                       | Multiple verification modes                                  | Not returned | Returned     |          |
| DocExpirationDate                      | Format: YYYY-MM-DD                                           | Not returned | Returned     |          |
| DocIssueDate                           | Format: YYYY-MM-DD                                           | Not returned | Returned     |          |
| DocIssuer                              | Format: Alphanumeric, 2                                      | Not returned | Returned     |          |
| DocId                                  | Format: Alphanumeric, 3-16                                   | Not returned | Returned     |          |
| DocType                                | SSN / PASS / UDL / MCN / INMATE / EIN                        | Not returned | Returned     |          |
| UseShippingDetails                     | Format: Y/N                                                  | Not returned | Returned     |          |
| ShippingAddressLine1                   | Format: Alphanumeric, 30                                     | Not returned | Returned     |          |
| ShippingAddressLine2                   | Format: Alphanumeric, 30                                     | Not returned | Returned     |          |
| ShippingCity                           | Format: Alpha, 1-20                                          | Not returned | Returned     |          |
| ShippingState                          | Format: Alphanumeric, 2                                      | Not returned | Returned     |          |
| ShippingZip                            | —                                                            | Not returned | Returned     |          |
| SubscribeToEmail                       | Y/N (default N)                                              | Not returned | Returned     |          |
| UserDefined1                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined2                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined3                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined4                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined5                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined6                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined7                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined8                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined9                           | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined10                          | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined11                          | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined12                          | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined13                          | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined14                          | Size: 255                                                    | Not returned | Returned     |          |
| UserDefined15                          | Size: 255                                                    | Not returned | Returned     |          |
| AuthorizedUser                         | —                                                            | Not returned | Returned     |          |
| CardholderBankRouting                  | Format: Numeric, 9                                           | Not returned | Returned     |          |
| CardholderBankName                     | Format: Alphanumeric, 100                                    | Not returned | Returned     |          |
| CardholderAccountNumber                | Format: Alphanumeric, 0-34                                   | Not returned | Returned     |          |
| CardholderAccountName                  | Format: Alphanumeric, 100                                    | Not returned | Returned     |          |
| ExternalPaymentProviderName1           | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderID1             | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderCreationDate1   | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderLastUpdateDate1 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderAdditionalInfo1 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderName2           | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderID2             | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderCreationDate2   | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderLastUpdateDate2 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderAdditionalInfo2 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderName3           | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderID3             | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderCreationDate3   | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderLastUpdateDate3 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderAdditionalInfo3 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderName4           | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderID4             | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderCreationDate4   | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderLastUpdateDate4 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderAdditionalInfo4 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderName5           | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderID5             | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderCreationDate5   | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderLastUpdateDate5 | —                                                            | Not returned | Returned     |          |
| ExternalPaymentProviderAdditionalInfo5 | —                                                            | Not returned | Returned     |          |
| IntAddressLine1                        | Format: Alphanumeric, 1-30                                   | Not returned | Returned     |          |
| IntAddressLine2                        | Format: Alphanumeric, 1-30                                   | Not returned | Returned     |          |
| IntCity                                | Format: Alpha, 1-20                                          | Not returned | Returned     |          |
| IntStateProvinceRegion                 | Format: Alphanumeric, 1-30                                   | Not returned | Returned     |          |
| IntCountry                             | ISO Country code (2 chars)                                   | Not returned | Returned     |          |
| IntZipPostalCode                       | Format: Alphanumeric, 1-20                                   | Not returned | Returned     |          |
| IntDocId                               | Format: Alphanumeric, 1-50                                   | Not returned | Returned     |          |
| IntDocType                             | Format: Alphanumeric, 1-50                                   | Not returned | Returned     |          |
| IntAddress                             | Format: Y/N                                                  | Not returned | Returned     |          |
| Language                               | English / Spanish                                            | Not returned | Returned     |          |
| MiddleName                             | Format: Alpha, 0-20                                          | Not returned | Returned     |          |
| SurName                                | Format: Alpha, 0-20                                          | Not returned | Returned     |          |
| AdditionalIDExpirationDate             | Format: YYYY-MM-DD                                           | Not returned | Returned     |          |

## XML Samples

### Input XML

```json
<?xml version="1.0" ?>
<PraxellXMLRequest>
 	<AuthenticationDetails>
         <SessionId>fe22d8c2-12cc-4684-a3d0-06b831038736</SessionId>
         <UniqueRequestId>fe22d8c2-12cc-4684-a3d0-06b831038736</UniqueRequestId>
     </AuthenticationDetails>
 	<ServiceDetails>
 		<ServiceName>GetCardholderData</ServiceName>
     </ServiceDetails>
 	<Origin>
 		<OriginType>Portal:csr</OriginType>
 	</Origin>
 	<ServiceParams>
     <ID>205</ID>
     <IDType>RPID</IDType>
 	</ServiceParams>
 </PraxellXMLRequest>
```

```json

<?xml version="1.0"?>
 <PraxellXMLResponse>
      <ResponseDetails>
         <ServiceName>GetCardholderData</ServiceName>
         <SessionId>fe22d8c2-12cc-4684-a3d0-06b831038736</SessionId>
         <StatusCode>0</StatusCode>
         <StatusName>StatusOK</StatusName>
         <StatusDescription>OK</StatusDescription>
         <StatusMessage></StatusMessage>
         <ServiceDate>2026-03-02 18:39:45</ServiceDate>
         <ServiceId>fe22d8c2-12cc-4684-a3d0-06b831038736</ServiceId>
     </ResponseDetails>
     <ResponseParams>
        <FirstName>Hazel Elaine</FirstName>
        <MiddleInitial></MiddleInitial>
        <LastName>Conner</LastName>
        <AddressLine1>FakeAddress</AddressLine1>
        <AddressLine2></AddressLine2>
        <City>FakeCity</City>
        <State>CA</State>
        <Zip>54321</Zip>
        <Country>US</Country>
        <Phone>123459876</Phone>
        <Fax></Fax>
        <Email></Email>
        <IsReceiveSms>Y</IsReceiveSms>
        <MobilePhone>123459876</MobilePhone>
        <IntPhoneNumber>972546644115</IntPhoneNumber>
        <EarlyAccess>Y</EarlyAccess>
        <DateOfBirth>1979-05-05</DateOfBirth>
        <VerificationRequest></VerificationRequest>
        <VerificationType></VerificationType>
        <DocExpirationDate></DocExpirationDate>
        <DocIssueDate></DocIssueDate>
        <DocIssuer></DocIssuer>
        <DocId>123456789</DocId>
        <DocType>SSN</DocType>
        <UseShippingDetails></UseShippingDetails>
        <ShippingAddressLine1></ShippingAddressLine1>
        <ShippingAddressLine2></ShippingAddressLine2>
        <ShippingCity></ShippingCity>
        <ShippingState></ShippingState>
        <ShippingZip></ShippingZip>
        <SubscribeToEmail></SubscribeToEmail>
   <UserDefined1>juice_3550.eps</UserDefined1>
   <UserDefined2>sencilla_cha_01_form_02</UserDefined2>
   <UserDefined3>7</UserDefined3>
   <UserDefined4></UserDefined4>
   <UserDefined5></UserDefined5>
   <UserDefined6></UserDefined6>
   <UserDefined7></UserDefined7>
   <UserDefined8></UserDefined8>
   <UserDefined9></UserDefined9>
   <UserDefined10></UserDefined10>
   <UserDefined11></UserDefined11>
   <UserDefined12>2</UserDefined12>
   <UserDefined13>3</UserDefined13>
   <UserDefined14>4</UserDefined14>
   <UserDefined15>5</UserDefined15>
        <AuthorizedUser>Tomer Madmon</AuthorizedUser>
        <CardholderBankRouting></CardholderBankRouting>
        <CardholderBankName>Madmon Bank</CardholderBankName>
        <CardholderAccountNumber>1234567890</CardholderAccountNumber>
        <CardholderAccountName></CardholderAccountName>
        <ExternalPaymentProviderName1>P.P 1</ExternalPaymentProviderName1>
        <ExternalPaymentProviderID1></ExternalPaymentProviderID1>
        <ExternalPaymentProviderCreationDate1></ExternalPaymentProviderCreationDate1>
        <ExternalPaymentProviderLastUpdateDate1>2024/11/26</ExternalPaymentProviderLastUpdateDate1>
        <ExternalPaymentProviderAdditionalInfo1>Bla Bla Bla</ExternalPaymentProviderAdditionalInfo1>
        <ExternalPaymentProviderName2></ExternalPaymentProviderName2>
        <ExternalPaymentProviderID2>56647747447</ExternalPaymentProviderID2>
        <ExternalPaymentProviderCreationDate2></ExternalPaymentProviderCreationDate2>
        <ExternalPaymentProviderLastUpdateDate2></ExternalPaymentProviderLastUpdateDate2>
        <ExternalPaymentProviderAdditionalInfo2></ExternalPaymentProviderAdditionalInfo2>
        <ExternalPaymentProviderName3></ExternalPaymentProviderName3>
        <ExternalPaymentProviderID3></ExternalPaymentProviderID3>
        <ExternalPaymentProviderCreationDate3></ExternalPaymentProviderCreationDate3>
        <ExternalPaymentProviderLastUpdateDate3></ExternalPaymentProviderLastUpdateDate3>
        <ExternalPaymentProviderAdditionalInfo3></ExternalPaymentProviderAdditionalInfo3>
        <ExternalPaymentProviderName4></ExternalPaymentProviderName4>
        <ExternalPaymentProviderID4></ExternalPaymentProviderID4>
        <ExternalPaymentProviderCreationDate4></ExternalPaymentProviderCreationDate4>
        <ExternalPaymentProviderLastUpdateDate4></ExternalPaymentProviderLastUpdateDate4>
        <ExternalPaymentProviderAdditionalInfo4></ExternalPaymentProviderAdditionalInfo4>
        <ExternalPaymentProviderName5></ExternalPaymentProviderName5>
        <ExternalPaymentProviderID5></ExternalPaymentProviderID5>
        <ExternalPaymentProviderCreationDate5></ExternalPaymentProviderCreationDate5>
        <ExternalPaymentProviderLastUpdateDate5></ExternalPaymentProviderLastUpdateDate5>
        <ExternalPaymentProviderAdditionalInfo5></ExternalPaymentProviderAdditionalInfo5>
        <IntAddressLine1>HaGalil 4</IntAddressLine1>
        <IntAddressLine2></IntAddressLine2>
        <IntCity>Beit Dagan</IntCity>
        <IntStateProvinceRegion>HaMerkaz</IntStateProvinceRegion>
        <IntCountry>IL</IntCountry>
        <IntZipPostalCode>5020000</IntZipPostalCode>
        <IntDocId>ID</IntDocId>
        <IntDocType>034450106</IntDocType>
        <IntAddress>Y</IntAddress>
        <Language>Spanish</Language>
     </ResponseParams>
</PraxellXMLResponse>
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.juicefin.com/apis/cardholder-management/get-cardholder-data.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
