# Update Cardholder Data

## Update Cardholder

The Update Cardholder Data API produces updates of cardholder details capable of handling update partially and removing data by using `__EMPTY__` key word.

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

| Name                       | Required | Definition                                                                                                                                                                                          | Condition                                 | Comments                            |                                     |
| -------------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | ----------------------------------- | ----------------------------------- |
| ID                         |     Y    | <p>Format: Numeric, 1-19<br>Description:<br>Input should be RPID in case IDType = RPID<br>Input should be Card Number in case IDType = CardNumber</p>                                               |                                           |                                     |                                     |
| IDType                     |     N    | <p>Format options:<br>CardNumber<br>RPID</p>                                                                                                                                                        |                                           | Default=CardNumber                  |                                     |
| AddressLine1               |     Y    | <p>Format: Alphanumeric, 1-30<br>Can contains as well all special characters beside: <, ></p>                                                                                                       |                                           |                                     |                                     |
| AddressLine2               |     N    | <p>Format: Alphanumeric, 1-30<br>Can contains as well all special characters beside: <, ></p>                                                                                                       |                                           |                                     |                                     |
| City                       |     Y    | <p>Format: Alpha, 1-20<br>Can contains as well these special characters: /, -, space, comma, period, &</p>                                                                                          |                                           |                                     |                                     |
| Country                    |     Y    | <p>Format: ISO Country code. Two characters.<br>Description: Based on ISO 3166-1 alpha-2 list.<br>\[<http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2](><http://en.wikipedia.org/wiki/ISO_[>...]</p> |                                           |                                     |                                     |
| DateOfBirth                |     N    | <p>Format: yyyy-mm-dd<br>Description: Cardholder must be above 17 years old</p>                                                                                                                     |                                           |                                     |                                     |
| DocExpirationDate          |     C    | <p>Format: YYYY-MM-DD<br>Description: must be after DocIssueDate.<br>Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'</p>                                                 |                                           |                                     |                                     |
| DocId                      |     N    | <p>Format: Alphanumeric, 3-16<br>Description: ID number of the government identification document used (defined in DocType)</p>                                                                     |                                           |                                     |                                     |
| DocIssueDate               |     C    | <p>Format: YYYY-MM-DD<br>Description: must be before DocExpirationDate<br>Conditional value required only when DocType is 'PASS' or 'MCN'</p>                                                       |                                           |                                     |                                     |
| DocIssuer                  |     C    | <p>Format: Alphanumeric, 2<br>Description: Country/State code.<br>Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'</p>                                                    |                                           |                                     |                                     |
| DocType                    |     N    | <p>Format options:<br>SSN<br>PASS<br>UDL<br>MCN<br>INMATE<br>EIN<br>Description: Closed list of values.Type of government identification document used: SSN- Social Security Number, PA\[...]</p>   |                                           |                                     |                                     |
| EarlyAccess                |     N    | Format: Y/N                                                                                                                                                                                         |                                           |                                     |                                     |
| Email                      |     N    | <p>Format: a-z (upper or lower), numbers, dash and underscore, 5-40<br>Description: Possible pattern: <x@x.x></p>                                                                                   |                                           |                                     |                                     |
| Fax                        |     N    | <p>Format: Numeric, 6-10<br>Description: the fax number.</p>                                                                                                                                        |                                           |                                     |                                     |
| FirstName                  |     Y    | <p>Format: Alpha, 2-20<br>Can contains as well these special characters: /, -, space, comma, period, &</p>                                                                                          |                                           |                                     |                                     |
| IsReceiveSms               |     N    | <p>Format options:<br>Enabled (the cardholder has requested to receive an SMS for transactions)<br>Disabled (the cardholder has requested not to receive an SMS)<br>Blank (the car\[...]</p>        |                                           |                                     |                                     |
| LastName                   |     Y    | <p>Format: Alpha, 2-20<br>Can contains as well these special characters: /, -, space, comma, period, &</p>                                                                                          |                                           |                                     |                                     |
| MiddleInitial              |     N    | <p>Format: Alpha,1<br>Description: Middle name char of the cardholder.</p>                                                                                                                          |                                           |                                     |                                     |
| MobilePhone                |     Y    | <p>Format: Numeric, 6-10<br>Description: Mobile Phone number</p>                                                                                                                                    |                                           |                                     |                                     |
| IntPhoneNumber             |     N    | <p>International phone number<br>Numeric with optional ("+") prefix<br>Format: ^(?!+?0+$)+?\d{6,}$<br>Example: +972546644445</p>                                                                    |                                           | Can send `__EMPTY__` to reset value |                                     |
| Phone                      |     N    | <p>Format: Numeric, 6-10<br>Description: Phone number</p>                                                                                                                                           |                                           |                                     |                                     |
| ShippingAddressLine1       |     N    | <p>Format: Alphanumeric, 30<br>Can contains as well all special characters beside: <, ></p>                                                                                                         |                                           |                                     |                                     |
| ShippingAddressLine2       |     N    | <p>Format: Alphanumeric, 30<br>Can contains as well all special characters beside: <, ></p>                                                                                                         |                                           |                                     |                                     |
| ShippingCity               |     N    | <p>Format: Alpha, 1-20<br>Can contains as well these special characters: /, -, space, comma, period</p>                                                                                             |                                           |                                     |                                     |
| ShippingState              |     N    | Format: Alphanumeric, 2                                                                                                                                                                             |                                           |                                     |                                     |
| ShippingZIP                |     N    | Format: Numeric, 5                                                                                                                                                                                  |                                           |                                     |                                     |
| State                      |     Y    | Format: Alphanumeric, 2                                                                                                                                                                             |                                           |                                     |                                     |
| VerificationRequest        |     Y    | <p>Format options:<br>UpdateAndVerify (allowed only when doc id type= SSN)<br>UpdateOnly<br>NoUpdateOnVerificationError (allowed only when doc id type = SSN)</p>                                   |                                           |                                     |                                     |
| Zip                        |     Y    | Format: Numeric, 5                                                                                                                                                                                  |                                           |                                     |                                     |
| SubscribeToEmail           |     N    | <p>Format: Y/N<br>Options:<br>Y - Yes, will send OTP in email<br>N - No, will not send OTP in email<br>Optional, Can be undefined<br>Default: N</p>                                                 |                                           |                                     |                                     |
| UserDefined1               |     N    | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*                                                                                                                                                       | &;@!\~=\_'<br>Size: 255</p>               |                                     | Can send `__EMPTY__` to reset value |
| UserDefined2-15            |     N    | <p>Format:<br>Chars: a-zA-Z0-9 .,#$()/:?-%+\*</p>                                                                                                                                                   | <p>&;@!\~=\_'<br>Size: 255</p>            |                                     |                                     |
| AuthorizedUser             |     N    |                                                                                                                                                                                                     |                                           | Can send `__EMPTY__` to reset value |                                     |
| CardholderBankName         |     N    | <p>Format: Alphanumeric, 100<br>^\[A-Za-z0-9\s/.,-]{0,100}$'</p>                                                                                                                                    |                                           | Can send `__EMPTY__` to reset value |                                     |
| CardholderAccountNumber    |     N    | <p>Format: Alphanumeric, 0-34<br>^\[a-zA-Z0-9]{0,34}$</p>                                                                                                                                           |                                           | Can send `__EMPTY__`to reset value  |                                     |
| CardholderAccountName      |     N    | <p>Format: Alphanumeric, 100<br>^\[A-Za-z0-9\s/.,-]{0,100}$</p>                                                                                                                                     |                                           | Can send `__EMPTY__` to reset value |                                     |
| CardholderBankRouting      |     N    | Format: Numeric, 9                                                                                                                                                                                  |                                           | Can send `__EMPTY__` to reset value |                                     |
| ExtPaymentProviderFields   |     N    | <p>Format: Alphanumeric, Date<br>^\[0-9A-Za-z /:.,+-]{0,30}$</p>                                                                                                                                    |                                           | Can send `__EMPTY__` to reset value |                                     |
| IntAddressLine1            |     C    | Format: Alphanumeric, 1-30 Can contains as well all special characters beside: <, >                                                                                                                 | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value |                                     |
| IntCity                    |     C    | Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period, &                                                                                                    | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value |                                     |
| IntCountry                 |     C    | Format: ISO Country code. Two characters.                                                                                                                                                           | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value |                                     |
| IntZipPostalCode           |     C    | Format: Alphanumeric, 1-20                                                                                                                                                                          | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value |                                     |
| IntDocId                   |     C    | Format: Alphanumeric, 1-50                                                                                                                                                                          | Must be supplied if IntAddress is Y (Yes) | Can send `__EMPTY__` to reset value |                                     |
| IntAddress                 |     N    | Format: Y/N (Default N)                                                                                                                                                                             |                                           |                                     |                                     |
| Language                   |     N    |                                                                                                                                                                                                     |                                           | Can send `__EMPTY__` to reset value |                                     |
| MiddleName                 |     N    |                                                                                                                                                                                                     |                                           | Can send `__EMPTY__` to reset value |                                     |
| SurName                    |     N    |                                                                                                                                                                                                     |                                           | Can send `__EMPTY__` to reset value |                                     |
| AdditionalIDExpirationDate |     N    |                                                                                                                                                                                                     |                                           | Can send `__EMPTY__` to reset value |                                     |

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

| Name                 | Definition                                                                                                                                                                                               | Failure Case | Success Case | Comments   |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------- |
| VerificationID       | Format: Alphanumeric, 50                                                                                                                                                                                 | Not returned | Returned     |            |
| VerificationStatus   | <p>Format options:<br>VerifiedSSN<br>VerifiedThirdParty<br>VerifiedDocumentary<br>VerifiedByIssuer<br>SSNVerificationRequired<br>DocumentaryVerificationRequired<br>OOWVerificationRequired<br>Blank</p> | Not returned | Returned     |            |
| VerificationAttempts | Format: Numeric, 2                                                                                                                                                                                       | Not returned | Returned     |            |
| QuestionSequence     | Format: Numeric, 1                                                                                                                                                                                       | Not returned | Returned     | Future Use |
| QuestionPrompt       | Format: Alphanumeric, 255                                                                                                                                                                                | Not returned | Returned     | Future Use |
| QuestionType         | Format: Alphanumeric, 255                                                                                                                                                                                | Not returned | Returned     | Future Use |
| AnswerOption         | Format: Alphanumeric, 255                                                                                                                                                                                | Not returned | Returned     | Future Use |
| OOWEligible          | Format: Y/N                                                                                                                                                                                              | Not returned | Returned     | Future Use |
| FreeTextErrors       | Format: Alphanumeric, 255                                                                                                                                                                                | Not returned | Returned     |            |
| CardHolderState      | <p>Format options:<br>V<br>V-PNS<br>RNV<br>NRNV</p>                                                                                                                                                      | Not returned | Returned     |            |

## XML Samples

### Input XML

```json
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>test_csrpm</UserName>
        <UserPassword***</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>UpdateCardholderData</ServiceName>
        <UniqueRequestId>e461e304-ec98-43d0-9ff9-4544909f954a</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtAPI</OriginType>
    </Origin>
    <ServiceParams>
        <ID>9900001025</ID>
        <IDType>RPID</IDType>
		<AuthorizedUser>Tomer Madmon</AuthorizedUser>
        <ExternalPaymentProviderName1>P.P 1</ExternalPaymentProviderName1>
		<ExternalPaymentProviderID1>123456789</ExternalPaymentProviderID1>
		<ExternalPaymentProviderLastUpdateDate1>2024/11/26</ExternalPaymentProviderLastUpdateDate1>        
        <ExternalPaymentProviderID2>56647747447</ExternalPaymentProviderID2>
		<ExternalPaymentProviderCreationDate2>__EMPTY__</ExternalPaymentProviderCreationDate2>
		<ExternalPaymentProviderLastUpdateDate2>__EMPTY__</ExternalPaymentProviderLastUpdateDate2>
		<ExternalPaymentProviderAdditionalInfo2>__EMPTY__</ExternalPaymentProviderAdditionalInfo2>
    </ServiceParams>
</PraxellXMLRequest>

Response:
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>UpdateCardholderData</ServiceName>
        <SessionId>62b72256-e524-40a2-b7ce-33ca4a198852</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>OK</StatusDescription>
        <StatusMessage></StatusMessage>
        <ServiceDate>2026-02-17 08:39:30</ServiceDate>
        <ServiceId>62b72256-e524-40a2-b7ce-33ca4a198852</ServiceId>
    </ResponseDetails>
	<ResponseParams>
        <VerificationAttempts>1</VerificationAttempts>
</ResponseParams>
</PraxellXMLResponse>
```

```json
Request:
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>test_csrpm</UserName>
        <UserPassword***</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>UpdateCardholderData</ServiceName>
        <UniqueRequestId>f31c81d9-157b-41e1-ab3e-aab35cdb85ec</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtAPI</OriginType>
    </Origin>
    <ServiceParams>
        <ID>9900001025</ID>
        <IDType>RPID</IDType>
		<MiddleInitial>S</MiddleInitial>
		<LastName>Madmon</LastName>
	</ServiceParams>
</PraxellXMLRequest>

Response:
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>UpdateCardholderData</ServiceName>
        <SessionId>b3c41c7a-adb5-43b7-bdec-6004d2833ac6</SessionId>
        <StatusCode>70223</StatusCode>
        <StatusName>UpdateCardholderFailed</StatusName>
        <StatusDescription>Update cardholder failure</StatusDescription>
        <StatusMessage> Err19: 40001 (Access denied.)</StatusMessage>
        <ServiceDate>2026-02-17 08:34:51</ServiceDate>
        <ServiceId>b3c41c7a-adb5-43b7-bdec-6004d2833ac6</ServiceId>
    </ResponseDetails>
</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/card-status-and-management/update-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.