GAgalileo-ft
Accounts and Cards

Update Account

Changed on

Use the Update Account endpoint to modify customer profile information in an existing customer record. Pass only the parameters to modify — other parameters should be left blank. Only active accounts (status: N) can be updated using this endpoint, unless you set provider parameter UPDCZ to update accounts in status: C or status: Z.

Nullifying data elements

Pass the string null for any of these parameters to update that value to null.

firstNamemiddleNamelastNameaddress1
citystatepostalCodeprimaryPhone
otherPhonemobilePhoneshipToAddress1webUid
secretQuestionsecretAnswermailBouncedemail*
embossLine2
*Only if the provider parameter AENUL is set.

[block:callout]

{ "type": "warning", "title": "Warning", "body": "Exercise caution when nullifying a primary address — for compliance in the United States you must maintain a physical address as an individual cardholder's primary address." } [/block]

Updating customer ID

When you are using the SoFi Tech Solutions integrated <glossary:IVS> process, you can update the primary customer ID (id and idType) as long as the customer has not passed customer identity verification. If the customer has already passed IVS, status code 415-02 is returned. Secondary and tertiary customer IDs (id2/idType2 and id3/idType3) can be updated regardless of customer-verification status, but they cannot be nullified or cleared. If you omit those keys, the current value is not changed.

Updating the ship-to address

When updating the ship-to address for a customer, the elements shipToAddress1, shipToCity, shipToState, and shipToPostalCode are required – shipToAddress2 is optional. You can retrieve the current customer ship-to address data using the <a href="ref:post_getaccountcards" target="_blank">Get Account Cards</a> endpoint.

By default, the embosser sends the card to the primary address. To ship to a different address than the primary, use the ship-to address fields. If you pass shipToAddressPermanent: 1 the embosser will always send cards to the ship-to address; otherwise, the ship-to address is used only for the current order.

post/updateAccount

Request

  • Base URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/ (relative, and the document’s source URL is not known)
  • URL
    api-{corename}.{env}.gpsrv.com/intserv/4.0/updateAccount
  • Auth
    none declared

Request body application/x-www-form-urlencoded

apiLoginstring required

Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: "AbC123-9999"

apiTransKeystring required

Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: "4sb62fh6w4h7w34g"

providerIdinteger required

Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: 9999

transactionIdstring required

Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for <a href="ref:idempotency#endpoints-that-use-transactionid-for-idempotency" target="_blank">idempotency</a>. A UUID is preferred. Pattern: Maximum 60 characters Example: "9845dk-39fdk3fj3-4483483478"

accountNostring nullable

The <glossary:PRN> or <glossary:PAN> of the account. Pattern: PAN or PRN Example: "074103447228"

idType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 nullable

Specifies the type of identifier in id. This parameter is required when id is populated. See the idType column in the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> table for valid values. When using the SoFi Tech Solutions <glossary:IVS> integration, only 2 and 15 are valid. Pattern: Integer Example: 2

idstring nullable

The value of the primary identifier that is specified in idType. This parameter is required when using the SoFi Tech Solutions <glossary:IVS> integration. This value cannot be changed after the customer passes ID verification. All letters will be converted to lowercase. Pattern: As specified in the Layout for id column of the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> enumeration Example: "123456789"

idType20 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 nullable

Specifies the type of identifier in id2. This parameter is required when id2 is populated. See the idType column in the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> table for valid values. Pattern: Integer Example: 1

id2string nullable

The value of the identifier that is specified in idType2. This value can be changed but not nullified or cleared. All letters will be converted to lowercase. See <a href="doc:design-a-card#specifying-a-card-design" target="_blank">Specifying a card design</a> for non-<glossary:KYC> uses of id2. Pattern: As specified in the Layout for id column of the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> enumeration Example: "123456789012|ut|12/25/2020"

idType30 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 nullable

Specifies the type of identifier in id3. This parameter is required when id3 is populated. See the idType column in the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> table for valid values. Pattern: Integer Example: 13

id3string nullable

The value of the identifier that is specified in idType3. All letters will be converted to lowercase. This value can be changed but not nullified or cleared. Pattern: As specified in the Layout for id column of the <a href="ref:api-reference-customer-id-types" target="_blank">Customer ID Types</a> enumeration Example: "abc123456789|05-22-2027"

locationType0 | 1 | 2 | 3 nullable

Type of ID in location:

  • 0 — SoFi Tech Solutions location ID
  • 1 — Partner location ID
  • 2 — Don't validate
  • 3 — Instant-issue location override. Valid for Create Account only. See <a href="doc:setup-for-instant-issue#step-5-enroll-customer-and-issue-card" target="_blank">Setup for Instant Issue</a> for details.

Pattern: Integer Example: 0

locationstring nullable

Unique location identifier (location) as returned by the <a href="ref:post_createlocation" target="_blank">Create Location</a> endpoint. This value is also returned by the <a href="ref:post_getlocations" target="_blank">Get Locations</a> endpoint depending on the value of locationType when the location was created:

  • 0 or 2 — Returned in the location_id field
  • 1 — Returned in the provider_specified_id field

Pattern: Integer if locationType: 0 or locationType: 2; max 15 characters if locationType: 1 Example: "a455-3483"

locale'en_US' | 'es_US' | 'en_CA' | 'fr_CA' | 'es_MX' | 'en_MX' nullable

The account holder language and localization preference. Valid values are en_US, es_US, fr_CA, en_CA, es_MX, en_MX. If the account holder address is outside the U.S., pass a non _US value for this parameter to disable U.S. address validation. Pattern: Letters with underscore Example: "en_US"

externalAccountIdstring nullable

User-supplied identifier that is related to an external system. This ID is stored in the system in association with this account and can be provided in the <glossary:RDF>s. Pattern: Max 30 alphanumeric characters. Lowercase only. Example: "553b45sbs"

firstNamestring nullable

Account holder's first name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Ed"

middleNamestring nullable

Account holder's middle name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "W"

lastNamestring nullable

Account holder's last name. <a href="ref:api-reference-special-characters" target="_blank">Special character support</a>. Pattern: 1–40 characters: letters (A-Z, a-z), spaces, hyphens (-) and single quotes (') Example: "Harley"

dateOfBirthstring date-time nullable

Account holder's birth date. This date is compared with the DOB product parameter when there is a minimum age requirement on the account. Pattern: YYYY-MM-DD Example: "1980-01-01"

address1string nullable

Account holder's first address line. Cannot be a P.O. box. <a href="ref:api-reference-address1-validation" target="_blank">Validation rules for address1</a>. Pattern: 4–40 alphanumeric characters Example: "33 Maple Street"

address2string nullable

Account holder's second address line. Pattern: Max 40 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "#4B"

address3string nullable

Account holder's third address line. Pattern: Max 30 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "Carrera Central"

address4string nullable

Account holder's fourth address line. Pattern: Max 30 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "Barrio El Alhambra"

address5string nullable

Account holder's fifth address line. Pattern: Max 30 alphanumeric characters and <a href="ref:api-reference-special-characters#address-symbols" target="_blank">address symbols</a> Example: "Piso 3"

citystring nullable

Account holder's city. Pattern: Max 30 characters: letters, spaces, hyphen and period Example: "Salt Lake City"

statestring nullable

Account holder's state or province. Pattern: String Example: "UT"

postalCodestring nullable

Account holder's postal code (ZIP code). Pattern: 1234, 12345, 12345-1234, or K1A-1A1 Example: "84121"

countryCodestring nullable

Account holder's country. Three-digit UN M49 code, such as 840 for USA, 124 for Canada, 484 for Mexico, 170 for Colombia. Pattern: 3-digit number Example: "840"

primaryPhonestring nullable

Account holder's primary phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode. Pattern: Validation according to the value in mobilePhoneCountryCode. Example: "8015556060"

otherPhonestring nullable

Account holder's secondary phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode. Pattern: Validation according to the value in mobilePhoneCountryCode. Example: "8015556060"

mobilePhonestring nullable

Account holder's mobile phone number. When passing a value for this parameter, you must also pass mobilePhoneCountryCode. Pattern: Validation according to the value in mobilePhoneCountryCode. Example: "8015556060"

mobileCarrierIdstring nullable

Account holder's mobile carrier. Configurable list. Pattern: Configurable list Example: "8"

emailstring nullable

Account holder's email. Pattern: Email address, 3–63 characters Example: "user@fakedomain.com"

webUidstring nullable

Account holder's username for the website hosted by SoFi Tech Solutions. Must be unique across the program. Pattern: Alphanumeric, with first character a letter; case insensitive Example: "eharley"

webPwdstring nullable

Account holder's password for the website hosted by SoFi Tech Solutions. Pattern: Min 8 characters: must include upper-case character, lower-case character, and a number Example: "4j9KH3kkdh"

secretQuestionstring nullable

Account holder's secret question for the website hosted by SoFi Tech Solutions. Pattern: Max 50 characters: letters, spaces, ? Example: "What was the name of your first pet?"

secretAnswerstring nullable

Account holder's answer to secretQuestion. Pattern: Max 50 characters: letters, spaces, ? Example: "Larry"

incomeSourcestring nullable

Account holder's employer name or income source. Pattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, @, & and comma. Example: "Kroger Food & Drug"

occupationstring nullable

Account holder's occupation. Pattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, @, & and comma. Example: "Project Manager"

nationalitystring nullable

Account holder's nationality. Pattern: 2-character ISO-3166-2 code :Example: "MX"

placeOfBirthstring nullable

Account holder's place of birth Pattern: ISO-3166-2 subdivision code Example: MX-YUC

curpstring nullable

Account holder's <glossary:CURP> Pattern: 18 alphanumeric characters Example: "HRGRAL82050602H900"

politicalAffiliationinteger nullable

Whether the account holder is a <glossary:PEP>.

  • 1 — PEP
  • 0 — Not a PEP.
kycRefNostring nullable

<glossary:KYC> reference number to track the KYC process for the account holder. Pattern: 36 characters Example: "KYC123456789012312312312521312312312"

monthlyIncomenumber float nullable

Monthly income for the account holder. Pattern: Float between 0 and 9999999999 Example: 3400.00

externalCustomerIdstring nullable

User-supplied identifier that is related to an external system. Pattern: Max 512 characters: all ASCII characters Example: "acv#-@45!sbsxm%-"

mailBouncedstring nullable

Y indicates that mail has been returned to sender. Pattern: Y or N Example: "Y"

shipToAddress1string nullable

First ship-to address line. Pattern: Max 40 characters Example: "33 business parkway"

shipToAddress2string nullable

Second ship-to address line. Pattern: Max 40 characters Example: "Suite 400"

shipToCitystring nullable

Ship-to city. Pattern: Max 30 characters Example: "Salt Lake City"

shipToStatestring nullable

Ship-to state. Pattern: String Example: "UT"

shipToPostalCodestring nullable

Ship-to ZIP or postal code. Pattern: 1234, 12345, 12345-1234, K1A-1A1 Example: "841213333"

shipToCountryCodestring nullable

Ship-to country. Three-digit UN M49 country code, such as 840 for USA, 124 for Canada, 484 for Mexico, 170 for Colombia. Pattern: 3-digit number Example: "840"

shipToAddressPermanentstring nullable

Pass 1 to always ship cards to the ship-to address instead of one time only. Pattern: 0 or 1 Example: "1"

embossLine2string nullable

Second line to emboss on the card. Pattern: <a href="ref:api-reference-special-characters#embossline2-characters" target="_blank">Supported characters</a> Example: "Scarlet Ibis Shipping"

businessNamestring nullable

Account holder's business name. This field is required if prodId is a business product. Pattern: 2–150 characters. See the <a href="ref:api-reference-special-characters#businessname-parameter" target="_blank">supported character set</a>. Example: "Ed%26Ted"

mobilePhoneCountryCodestring nullable

Account holder's mobile phone country code. Pattern: A plus sign followed by 1–3 digits. See <a href="ref:api-reference-phone-validation" target="_blank">Phone Validation</a> for valid values. Example: "+1"

Example request

{
  "apiLogin": "AbC123-9999",
  "apiTransKey": "4sb62fh6w4h7w34g",
  "providerId": 9999,
  "transactionId": "123e4567-e89b-12d3-a456-426614174000",
  "accountNo": "074103447228",
  "idType": 2,
  "id": "123456789",
  "idType2": 1,
  "id2": "123456789012|ut|12/25/2020",
  "idType3": 13,
  "id3": "abc123456789|05-22-2027",
  "location": "a455-3483",
  "locale": "en_US",
  "externalAccountId": "553b45sbs",
  "firstName": "Ed",
  "middleName": "W",
  "lastName": "Harley",
  "dateOfBirth": "1980-01-01",
  "address1": "33 Maple Street",
  "address2": "#4B",
  "address3": "Carrera Central",
  "address4": "Barrio El Alhambra",
  "address5": "Piso 3",
  "city": "Salt Lake City",
  "state": "UT",
  "postalCode": "84121",
  "countryCode": "840",
  "primaryPhone": "8013656060",
  "otherPhone": "8013656060",
  "mobilePhone": "8013656060",
  "mobileCarrierId": "8",
  "email": "user@fakedomain.com",
  "webUid": "eharley",
  "webPwd": "4j9KH3kkdh",
  "secretQuestion": "What was the name of your first pet?",
  "secretAnswer": "Larry",
  "incomeSource": "Kroger Food & Drug",
  "occupation": "Project Manager",
  "nationality": "MX",
  "placeOfBirth": "MX-YUC",
  "curp": "HRGRAL82050602H900",
  "kycRefNo": "KYC123456789012312312312521312312312",
  "externalCustomerId": "acv#-@45!sbsxm%-",
  "mailBounced": "Y",
  "shipToAddress1": "33 business parkway",
  "shipToAddress2": "Suite 400",
  "shipToCity": "Salt Lake City",
  "shipToState": "UT",
  "shipToPostalCode": "841213333",
  "shipToCountryCode": "840",
  "shipToAddressPermanent": "1",
  "embossLine2": "Scarlet Ibis Shipping",
  "businessName": "Ed",
  "mobilePhoneCountryCode": "+1"
}

Response

status_codeinteger nullable required

The response status code. May return a string for some statuses.

statusstring nullable required

The condition of a process or response

processing_timenumber float nullable required

The time elapsed in processing the transaction

system_timestampstring date-time nullable required

A system generated timestamp

rtokenstring nullable required

A system-generated ID used for tracking

errorsstring[]

A list of errors generated while the request was processed

Changes