--- title: "Update Account" method: POST path: "/updateAccount" tags: ["Accounts and Cards"] --- # Update Account `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 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`. | | | | | |:--|:--|:--|:--| | `firstName` | `middleName` | `lastName` | `address1` | | `city` | `state` | `postalCode` | `primaryPhone` | | `otherPhone` | `mobilePhone` | `shipToAddress1` | `webUid` | | `secretQuestion` | `secretAnswer` | `mailBounced` | `email`\* | | `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 <> 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 Get Account Cards 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. ## Request body `application/x-www-form-urlencoded` - object - `apiLogin` string, required: Web service username, as provided by SoFi Tech Solutions. Pattern: Max 50 characters Example: `"AbC123-9999"` - `apiTransKey` string, required: Web service password, as provided by SoFi Tech Solutions. Pattern: Max 15 characters Example: `"4sb62fh6w4h7w34g"` - `providerId` integer, required: Your unique provider identifier from SoFi Tech Solutions. Pattern: Max 10 digits Example: `9999` - `transactionId` string, required: Supply a globally unique ID to identify this endpoint request ("transaction"). Might be used for idempotency. A UUID is preferred. Pattern: Maximum 60 characters Example: `"9845dk-39fdk3fj3-4483483478"` - `accountNo` string, nullable: The <> or <> of the account. Pattern: PAN or PRN Example: `"074103447228"` - `idType` 0 | 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 Customer ID Types table for valid values. When using the SoFi Tech Solutions <> integration, only `2` and `15` are valid. Pattern: Integer Example: `2` - `id` string, nullable: The value of the primary identifier that is specified in `idType`. This parameter is **required** when using the SoFi Tech Solutions <> 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 Customer ID Types enumeration Example: `"123456789"` - `idType2` 0 | 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 Customer ID Types table for valid values. Pattern: Integer Example: `1` - `id2` string, 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 Specifying a card design for non-<> uses of `id2`. Pattern: As specified in the **Layout for `id`** column of the Customer ID Types enumeration Example: `"123456789012|ut|12/25/2020"` - `idType3` 0 | 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 Customer ID Types table for valid values. Pattern: Integer Example: `13` - `id3` string, 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 Customer ID Types enumeration Example: `"abc123456789|05-22-2027"` - `locationType` 0 | 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 Setup for Instant Issue for details. Pattern: Integer Example: `0` - `location` string, nullable: Unique location identifier (`location`) as returned by the Create Location endpoint. This value is also returned by the Get Locations 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"` - `externalAccountId` string, 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 <>s. Pattern: Max 30 alphanumeric characters. Lowercase only. Example: `"553b45sbs"` - `firstName` string, nullable: Account holder's first name. Special character support. Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`) Example: `"Ed"` - `middleName` string, nullable: Account holder's middle name. Special character support. Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`) Example: `"W"` - `lastName` string, nullable: Account holder's last name. Special character support. Pattern: 1–40 characters: letters (`A-Z`, `a-z`), spaces, hyphens (`-`) and single quotes (`'`) Example: `"Harley"` - `dateOfBirth` string, 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"` - `address1` string, nullable: Account holder's first address line. Cannot be a P.O. box. Validation rules for `address1`. Pattern: 4–40 alphanumeric characters Example: `"33 Maple Street"` - `address2` string, nullable: Account holder's second address line. Pattern: Max 40 alphanumeric characters and address symbols Example: `"#4B"` - `address3` string, nullable: Account holder's third address line. Pattern: Max 30 alphanumeric characters and address symbols Example: `"Carrera Central"` - `address4` string, nullable: Account holder's fourth address line. Pattern: Max 30 alphanumeric characters and address symbols Example: `"Barrio El Alhambra"` - `address5` string, nullable: Account holder's fifth address line. Pattern: Max 30 alphanumeric characters and address symbols Example: `"Piso 3"` - `city` string, nullable: Account holder's city. Pattern: Max 30 characters: letters, spaces, hyphen and period Example: `"Salt Lake City"` - `state` string, nullable: Account holder's state or province. Pattern: String Example: `"UT"` - `postalCode` string, nullable: Account holder's postal code (ZIP code). Pattern: `1234`, `12345`, `12345-1234`, or `K1A-1A1` Example: `"84121"` - `countryCode` string, 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"` - `primaryPhone` string, 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"` - `otherPhone` string, 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"` - `mobilePhone` string, 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"` - `mobileCarrierId` string, nullable: Account holder's mobile carrier. Configurable list. Pattern: Configurable list Example: `"8"` - `email` string, nullable: Account holder's email. Pattern: Email address, 3–63 characters Example: `"user@fakedomain.com"` - `webUid` string, 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"` - `webPwd` string, 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"` - `secretQuestion` string, 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?"` - `secretAnswer` string, nullable: Account holder's answer to `secretQuestion`. Pattern: Max 50 characters: letters, spaces, `?` Example: `"Larry"` - `incomeSource` string, nullable: Account holder's employer name or income source. Pattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, `@`, `&` and comma. Example: `"Kroger Food & Drug"` - `occupation` string, nullable: Account holder's occupation. Pattern: Max 60 characters: alphanumeric, space, underscore, hyphen, period, `@`, `&` and comma. Example: `"Project Manager"` - `nationality` string, nullable: Account holder's nationality. Pattern: 2-character ISO-3166-2 code :Example: `"MX"` - `placeOfBirth` string, nullable: Account holder's place of birth Pattern: ISO-3166-2 subdivision code Example: MX-YUC - `curp` string, nullable: Account holder's <> Pattern: 18 alphanumeric characters Example: `"HRGRAL82050602H900"` - `politicalAffiliation` integer, nullable: Whether the account holder is a <>. - `1` — PEP - `0` — Not a PEP. - `kycRefNo` string, nullable: <> reference number to track the KYC process for the account holder. Pattern: 36 characters Example: `"KYC123456789012312312312521312312312"` - `monthlyIncome` number, float, nullable: Monthly income for the account holder. Pattern: Float between 0 and 9999999999 Example: `3400.00` - `externalCustomerId` string, nullable: User-supplied identifier that is related to an external system. Pattern: Max 512 characters: all ASCII characters Example: `"acv#-@45!sbsxm%-"` - `mailBounced` string, nullable: `Y` indicates that mail has been returned to sender. Pattern: `Y` or `N` Example: `"Y"` - `shipToAddress1` string, nullable: First ship-to address line. Pattern: Max 40 characters Example: `"33 business parkway"` - `shipToAddress2` string, nullable: Second ship-to address line. Pattern: Max 40 characters Example: `"Suite 400"` - `shipToCity` string, nullable: Ship-to city. Pattern: Max 30 characters Example: `"Salt Lake City"` - `shipToState` string, nullable: Ship-to state. Pattern: String Example: `"UT"` - `shipToPostalCode` string, nullable: Ship-to ZIP or postal code. Pattern: `1234`, `12345`, `12345-1234`, `K1A-1A1` Example: `"841213333"` - `shipToCountryCode` string, 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"` - `shipToAddressPermanent` string, nullable: Pass `1` to always ship cards to the ship-to address instead of one time only. Pattern: `0` or `1` Example: `"1"` - `embossLine2` string, nullable: Second line to emboss on the card. Pattern: Supported characters Example: `"Scarlet Ibis Shipping"` - `businessName` string, nullable: Account holder's business name. This field is **required** if `prodId` is a business product. Pattern: 2–150 characters. See the supported character set. Example: `"Ed%26Ted"` - `mobilePhoneCountryCode` string, nullable: Account holder's mobile phone country code. Pattern: A plus sign followed by 1–3 digits. See Phone Validation for valid values. Example: `"+1"` ## Response `default` - object - `status_code` integer, nullable, required: The response status code. May return a string for some statuses. - `status` string, nullable, required: The condition of a process or response - `processing_time` number, float, nullable, required: The time elapsed in processing the transaction - `echo` object, nullable, required: A structure that contains transaction ID information - `transaction_id` string, nullable, required: An ID that represents an API transaction - `provider_timestamp` string, date-time, nullable, required: Store a related timestamp for reporting and troubleshooting purposes - `provider_transaction_id` string, nullable, required: Secondary transaction identifier (generated by a provider) - `system_timestamp` string, date-time, nullable, required: A system generated timestamp - `rtoken` string, nullable, required: A system-generated ID used for tracking - `errors` string[]: A list of errors generated while the request was processed - `response_data` object, nullable, required: A structure for the response data. It can be empty but usually will contain information. - `customer_profile` object, required - `first_name` string, nullable, required: The first name on a profile - `middle_name` string, nullable, required: The middle name on a profile - `last_name` string, nullable, required: The last name on a profile - `preferred_name` string, nullable: The preferred name on a profile, to appear on cards and CST profiles. The preferred name feature is currently in development. Additional configuration is required. Contact SoFi Tech Solutions if you are interested in this feature. - `preferred_name_only_on_card` string, nullable: Whether the preferred name overrides only the `first_name` (default) or also `middle_name` and `last_name`. The preferred name feature is currently in development. Additional configuration is required. Contact SoFi Tech Solutions if you are interested in this feature. - `address_1` string, nullable, required: Street and residence number on the account - `address_2` string, nullable, required: Additional address information on the account - `city` string, nullable, required: City for address information - `state` string, nullable, required: State for address information - `postal_code` string, nullable: A postal code for the address information - `country_code` string, nullable, required: The ISO 3166 international standard for country codes - `phone` string, nullable: The home phone number on a profile - `mobile_phone` string, nullable, required: The home phone number on a profile - `mobile_phone_country_code` string, nullable: The calling code for the mobile phone number on a profile - `email` string, nullable, required: The email address on a profile - `ship_to_address` object, nullable, required - `address_1` string, nullable, required: The ship to address on the account - `address_2` string, nullable, required: Additional ship to address information - `city` string, nullable, required: City for the ship to address - `state` string, nullable, required: State for ship to address - `postal_code` string, nullable, required: Postal code for ship to address - `country_code` string, nullable, required: ISO 3166 country code for ship to address - `express_mail` string, nullable, required: Whether or not the profile uses express mail service - `related_accounts` integer, nullable, required: The number of related accounts - `occupation` string, nullable, required: The occupation of a person as listed in a profile - `income_source` string, nullable, required: How the person on a profile earns income - `emboss_line_2` string, nullable, required: Second embossed line on a card ## Changes - **2026-11-03** `1ede7567a879`: 1 info - endpoint added [Operation history](https://skmtc.dev/galileo-ft/apis/program-api/changes/updateAccount/post.md) --- [API](https://skmtc.dev/galileo-ft/apis/program-api.md) - [All operations](https://skmtc.dev/galileo-ft/apis/program-api/llms.txt) - [OpenAPI document](https://skmtc.dev/galileo-ft/apis/program-api/revisions/1ede7567a879?raw)