# Update Cardholder ## Update Cardholder The Update Cardholder API produces updates of cardholder details. ## Input Parameters: | Name | Required | Definition | Comments | | ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | | AddressLine1 | Y |

Format: Alphanumeric, 1-30
Can contains as well all special characters beside: <, >

| | | AddressLine2 | N |

Format: Alphanumeric, 1-30
Can contains as well all special characters beside: <, >

| | | CardAnniversaryDate | N | Format: YYYY-MM-DD | Future | | CardNumber | Y | Format: Numeric, 16 | | | City | Y |

Format: Alpha, 1-20
Can contains as well these special characters: /, -, space, comma, period, &

| | | Country | Y |

Format: ISO Country code. Two characters.
Description: Based on ISO 3166-1 alpha-2 list.

| | | DateOfBirth | N |

Format: yyyy-mm-dd
Description: Cardholder must be above 17 years old

| | | DocExpirationDate | C |

Format: YYYY-MM-DD
Description: must be after DocIssueDate.
Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'

| | | DocId | N |

Format: Alphanumeric, 3-16
Description: ID number of the government identification document used (defined in DocType)

| | | DocIssueDate | C |

Format: YYYY-MM-DD
Description: must be before DocExpirationDate
Conditional value required only when DocType is 'PASS' or 'MCN'

| | | DocIssuer | C |

Format: Alphanumeric, 2
Description: Country/State code.
Conditional value required only when DocType is 'PASS' 'IDL' 'UDL'or 'MCN'

| | | DocType | N |

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.

| | | EarlyAccess | N | Format: Y/N | | | Email | N |

Format: a-z (upper or lower), numbers, dash and underscore, 5-40
Description: Possible pattern:

| | | Fax | N |

Format: Numeric, 6-10
Description: the fax number.

| | | FirstName | Y |

Format: Alpha, 2-50
Can contains as well these special characters: /, -, space, comma, period, &

| | | IsReceiveSms | N |

Format options:
Enabled (the cardholder has requested to receive an SMS for transactions and therefore he get SMS's)
Disabled (the cardholder has requested to not receive an SMS for transactions and therefore he does not get SMS's)
Blank (the cardholder has not requested to receive an SMS for transactions and therefore he does not get SMS's)
Mail (the cardholder has requested to receive an mail for transactions and therefore he get mails)

Description:Defines if the cardholder gets an SMS/Mail.

| | | LastName | Y |

Format: Alpha, 2-50
Can contains as well these special characters: /, -, space, comma, period, &

| | | MiddleInitial | N |

Format: Alpha,1
Description: Middle name char of the cardholder.

| | | MobilePhone | Y |

Format: Numeric, 6-10
Description: Mobile Phone number

| | | Phone | N |

Format: Numeric, 6-10
Description: Phone number

| | | ShippingAddressLine1 | N |

Format: Alphanumeric, 30
Can contains as well all special characters beside: <, >

| | | ShippingAddressLine2 | N |

Format: Alphanumeric, 30
Can contains as well all special characters beside: <, >

| | | ShippingCity | N |

Format: Alpha, 1-20
Can contains as well these special characters: /, -, space, comma, period,

| | | ShippingState | N | Format: Alphanumeric, 2 | | | ShippingZIP | N | Format: Numeric, 5 | | | State | Y | Format: Alphanumeric, 2 | | | ShouldUpdateUserDefined | Y |

Format: Char (Y or N)
Description:
If you want to update field : Y
If you don't want to update field : N

| | | UserDefined1 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined2 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined3 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined4 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined5 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined6 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined7 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined8 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined9 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined10 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined11 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined12 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined13 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined14 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | UserDefined15 | N |

Format:
Chars: a-zA-Z0-9 .,#$()/:?-%+\*&;@!\~=\_'
Size: 255

| | | VerificationRequest | Y |

Format options:
UpdateAndVerify (allowed only when doc id type= SSN)
UpdateOnly
NoUpdateOnVerificationError (allowed only when doc id type = SSN)

| | | Zip | Y | Format: Numeric, 5 | | ## Output Parameters: | Name | Definition | Failure Case | Success Case | Comments | | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------ | ---------- | | VerificationID | Format: Alphanumeric, 50 | Not returned | Returned | | | VerificationStatus |

Format options:
VerifiedSSN
VerifiedThirdParty
VerifiedDocumentary
VerifiedByIssuer
SSNVerificationRequired
DocumentaryVerificationRequired
OOWVerificationRequired
Blank

| 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 |

Format options:
V
V-PNS
RNV
NRNV

| Not returned | Returned | | ## XML Samples ### Input XML ```json Eyal_PM_QA 1q2w3e4r ; UpdateCardholder 167565446597669 ExtAPI dana S dana Questions lala ACO AL 12348 US 1234568 1234568 sharon@gmail.com Enabled 9729999994 SSN 123456789 1944-01-20 Y UpdateAndVerify ``` ```json UpdateCardholder 0 StatusOK NA 2007-05-27 06:17:54 64303207200728062 ``` ```json UpdateCardholder 07071612200737105 70008 InvalidIssuer InvalidIssuer 2021-10-01 12:37:50 07071612200737105 ```